com.google.cloud.discoveryengine.v1alpha

Class AnswerQueryRequest.AnswerGenerationSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec

All Implemented Interfaces:

AnswerQueryRequest.AnswerGenerationSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

AnswerQueryRequest

public static final class AnswerQueryRequest.AnswerGenerationSpec
extends com.google.protobuf.GeneratedMessageV3
implements AnswerQueryRequest.AnswerGenerationSpecOrBuilder

 Answer generation specification.
 

Protobuf type google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AnswerQueryRequest.AnswerGenerationSpec.Builder Answer generation specification.
static class	AnswerQueryRequest.AnswerGenerationSpec.ModelSpec Answer Generation Model specification.
static interface	AnswerQueryRequest.AnswerGenerationSpec.ModelSpecOrBuilder
static class	AnswerQueryRequest.AnswerGenerationSpec.PromptSpec Answer generation prompt specification.
static interface	AnswerQueryRequest.AnswerGenerationSpec.PromptSpecOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANSWER_LANGUAGE_CODE_FIELD_NUMBER
static int	IGNORE_ADVERSARIAL_QUERY_FIELD_NUMBER
static int	IGNORE_LOW_RELEVANT_CONTENT_FIELD_NUMBER
static int	IGNORE_NON_ANSWER_SEEKING_QUERY_FIELD_NUMBER
static int	INCLUDE_CITATIONS_FIELD_NUMBER
static int	MODEL_SPEC_FIELD_NUMBER
static int	PROMPT_SPEC_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAnswerLanguageCode() Language code for Answer.
com.google.protobuf.ByteString	getAnswerLanguageCodeBytes() Language code for Answer.
static AnswerQueryRequest.AnswerGenerationSpec	getDefaultInstance()
AnswerQueryRequest.AnswerGenerationSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getIgnoreAdversarialQuery() Specifies whether to filter out adversarial queries.
boolean	getIgnoreLowRelevantContent() Specifies whether to filter out queries that have low relevance.
boolean	getIgnoreNonAnswerSeekingQuery() Specifies whether to filter out queries that are not answer-seeking.
boolean	getIncludeCitations() Specifies whether to include citation metadata in the answer.
AnswerQueryRequest.AnswerGenerationSpec.ModelSpec	getModelSpec() Answer generation model specification.
AnswerQueryRequest.AnswerGenerationSpec.ModelSpecOrBuilder	getModelSpecOrBuilder() Answer generation model specification.
com.google.protobuf.Parser<AnswerQueryRequest.AnswerGenerationSpec>	getParserForType()
AnswerQueryRequest.AnswerGenerationSpec.PromptSpec	getPromptSpec() Answer generation prompt specification.
AnswerQueryRequest.AnswerGenerationSpec.PromptSpecOrBuilder	getPromptSpecOrBuilder() Answer generation prompt specification.
int	getSerializedSize()
int	hashCode()
boolean	hasIgnoreLowRelevantContent() Specifies whether to filter out queries that have low relevance.
boolean	hasModelSpec() Answer generation model specification.
boolean	hasPromptSpec() Answer generation prompt specification.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static AnswerQueryRequest.AnswerGenerationSpec.Builder	newBuilder()
static AnswerQueryRequest.AnswerGenerationSpec.Builder	newBuilder(AnswerQueryRequest.AnswerGenerationSpec prototype)
AnswerQueryRequest.AnswerGenerationSpec.Builder	newBuilderForType()
protected AnswerQueryRequest.AnswerGenerationSpec.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static AnswerQueryRequest.AnswerGenerationSpec	parseDelimitedFrom(InputStream input)
static AnswerQueryRequest.AnswerGenerationSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnswerQueryRequest.AnswerGenerationSpec	parseFrom(byte[] data)
static AnswerQueryRequest.AnswerGenerationSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnswerQueryRequest.AnswerGenerationSpec	parseFrom(ByteBuffer data)
static AnswerQueryRequest.AnswerGenerationSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnswerQueryRequest.AnswerGenerationSpec	parseFrom(com.google.protobuf.ByteString data)
static AnswerQueryRequest.AnswerGenerationSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnswerQueryRequest.AnswerGenerationSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static AnswerQueryRequest.AnswerGenerationSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnswerQueryRequest.AnswerGenerationSpec	parseFrom(InputStream input)
static AnswerQueryRequest.AnswerGenerationSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AnswerQueryRequest.AnswerGenerationSpec>	parser()
AnswerQueryRequest.AnswerGenerationSpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

MODEL_SPEC_FIELD_NUMBER

public static final int MODEL_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

PROMPT_SPEC_FIELD_NUMBER

public static final int PROMPT_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

INCLUDE_CITATIONS_FIELD_NUMBER

public static final int INCLUDE_CITATIONS_FIELD_NUMBER

See Also:

Constant Field Values

ANSWER_LANGUAGE_CODE_FIELD_NUMBER

public static final int ANSWER_LANGUAGE_CODE_FIELD_NUMBER

See Also:

Constant Field Values

IGNORE_ADVERSARIAL_QUERY_FIELD_NUMBER

public static final int IGNORE_ADVERSARIAL_QUERY_FIELD_NUMBER

See Also:

Constant Field Values

IGNORE_NON_ANSWER_SEEKING_QUERY_FIELD_NUMBER

public static final int IGNORE_NON_ANSWER_SEEKING_QUERY_FIELD_NUMBER

See Also:

Constant Field Values

IGNORE_LOW_RELEVANT_CONTENT_FIELD_NUMBER

public static final int IGNORE_LOW_RELEVANT_CONTENT_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasModelSpec

public boolean hasModelSpec()

 Answer generation model specification.
 

.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;

Specified by:

hasModelSpec in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder

Returns:

Whether the modelSpec field is set.

getModelSpec

public AnswerQueryRequest.AnswerGenerationSpec.ModelSpec getModelSpec()

 Answer generation model specification.
 

.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;

Specified by:

getModelSpec in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder

Returns:

The modelSpec.

getModelSpecOrBuilder

public AnswerQueryRequest.AnswerGenerationSpec.ModelSpecOrBuilder getModelSpecOrBuilder()

 Answer generation model specification.
 

.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;

Specified by:

getModelSpecOrBuilder in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder

hasPromptSpec

public boolean hasPromptSpec()

 Answer generation prompt specification.
 

.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;

Specified by:

hasPromptSpec in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder

Returns:

Whether the promptSpec field is set.

getPromptSpec

public AnswerQueryRequest.AnswerGenerationSpec.PromptSpec getPromptSpec()

 Answer generation prompt specification.
 

.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;

Specified by:

getPromptSpec in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder

Returns:

The promptSpec.

getPromptSpecOrBuilder

public AnswerQueryRequest.AnswerGenerationSpec.PromptSpecOrBuilder getPromptSpecOrBuilder()

 Answer generation prompt specification.
 

.google.cloud.discoveryengine.v1alpha.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;

Specified by:

getPromptSpecOrBuilder in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder

getIncludeCitations

public boolean getIncludeCitations()

 Specifies whether to include citation metadata in the answer. The default
 value is `false`.
 

bool include_citations = 3;

Specified by:

getIncludeCitations in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder

Returns:

The includeCitations.

getAnswerLanguageCode

public String getAnswerLanguageCode()

 Language code for Answer. Use language tags defined by
 [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
 Note: This is an experimental feature.
 

string answer_language_code = 4;

Specified by:

getAnswerLanguageCode in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder

Returns:

The answerLanguageCode.

getAnswerLanguageCodeBytes

public com.google.protobuf.ByteString getAnswerLanguageCodeBytes()

 Language code for Answer. Use language tags defined by
 [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
 Note: This is an experimental feature.
 

string answer_language_code = 4;

Specified by:

getAnswerLanguageCodeBytes in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder

Returns:

The bytes for answerLanguageCode.

getIgnoreAdversarialQuery

public boolean getIgnoreAdversarialQuery()

 Specifies whether to filter out adversarial queries. The default value
 is `false`.

 Google employs search-query classification to detect adversarial
 queries. No answer is returned if the search query is classified as an
 adversarial query. For example, a user might ask a question regarding
 negative comments about the company or submit a query designed to
 generate unsafe, policy-violating output. If this field is set to
 `true`, we skip generating answers for adversarial queries and return
 fallback messages instead.
 

bool ignore_adversarial_query = 5;

Specified by:

getIgnoreAdversarialQuery in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder

Returns:

The ignoreAdversarialQuery.

getIgnoreNonAnswerSeekingQuery

public boolean getIgnoreNonAnswerSeekingQuery()

 Specifies whether to filter out queries that are not answer-seeking.
 The default value is `false`.

 Google employs search-query classification to detect answer-seeking
 queries. No answer is returned if the search query is classified as a
 non-answer seeking query. If this field is set to `true`, we skip
 generating answers for non-answer seeking queries and return
 fallback messages instead.
 

bool ignore_non_answer_seeking_query = 6;

Specified by:

getIgnoreNonAnswerSeekingQuery in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder

Returns:

The ignoreNonAnswerSeekingQuery.

hasIgnoreLowRelevantContent

public boolean hasIgnoreLowRelevantContent()

 Specifies whether to filter out queries that have low relevance.

 If this field is set to `false`, all search results are used regardless
 of relevance to generate answers. If set to `true` or unset, the behavior
 will be determined automatically by the service.
 

optional bool ignore_low_relevant_content = 7;

Specified by:

hasIgnoreLowRelevantContent in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder

Returns:

Whether the ignoreLowRelevantContent field is set.

getIgnoreLowRelevantContent

public boolean getIgnoreLowRelevantContent()

 Specifies whether to filter out queries that have low relevance.

 If this field is set to `false`, all search results are used regardless
 of relevance to generate answers. If set to `true` or unset, the behavior
 will be determined automatically by the service.
 

optional bool ignore_low_relevant_content = 7;

Specified by:

getIgnoreLowRelevantContent in interface AnswerQueryRequest.AnswerGenerationSpecOrBuilder

Returns:

The ignoreLowRelevantContent.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static AnswerQueryRequest.AnswerGenerationSpec parseFrom(ByteBuffer data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnswerQueryRequest.AnswerGenerationSpec parseFrom(ByteBuffer data,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnswerQueryRequest.AnswerGenerationSpec parseFrom(com.google.protobuf.ByteString data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnswerQueryRequest.AnswerGenerationSpec parseFrom(com.google.protobuf.ByteString data,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnswerQueryRequest.AnswerGenerationSpec parseFrom(byte[] data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnswerQueryRequest.AnswerGenerationSpec parseFrom(byte[] data,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnswerQueryRequest.AnswerGenerationSpec parseFrom(InputStream input)
                                                         throws IOException

Throws:

IOException

parseFrom

public static AnswerQueryRequest.AnswerGenerationSpec parseFrom(InputStream input,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static AnswerQueryRequest.AnswerGenerationSpec parseDelimitedFrom(InputStream input)
                                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static AnswerQueryRequest.AnswerGenerationSpec parseDelimitedFrom(InputStream input,
                                                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws IOException

Throws:

IOException

parseFrom

public static AnswerQueryRequest.AnswerGenerationSpec parseFrom(com.google.protobuf.CodedInputStream input)
                                                         throws IOException

Throws:

IOException

parseFrom

public static AnswerQueryRequest.AnswerGenerationSpec parseFrom(com.google.protobuf.CodedInputStream input,
                                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws IOException

Throws:

IOException

newBuilderForType

public AnswerQueryRequest.AnswerGenerationSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AnswerQueryRequest.AnswerGenerationSpec.Builder newBuilder()

newBuilder

public static AnswerQueryRequest.AnswerGenerationSpec.Builder newBuilder(AnswerQueryRequest.AnswerGenerationSpec prototype)

toBuilder

public AnswerQueryRequest.AnswerGenerationSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AnswerQueryRequest.AnswerGenerationSpec.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static AnswerQueryRequest.AnswerGenerationSpec getDefaultInstance()

parser

public static com.google.protobuf.Parser<AnswerQueryRequest.AnswerGenerationSpec> parser()

getParserForType

public com.google.protobuf.Parser<AnswerQueryRequest.AnswerGenerationSpec> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public AnswerQueryRequest.AnswerGenerationSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder