public static final class AnswerQueryRequest.AnswerGenerationSpec.Builder extends GeneratedMessageV3.Builder<AnswerQueryRequest.AnswerGenerationSpec.Builder> implements AnswerQueryRequest.AnswerGenerationSpecOrBuilderAnswer generation specification.
Protobuf type
google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AnswerQueryRequest.AnswerGenerationSpec.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AnswerQueryRequest.AnswerGenerationSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|
build()
public AnswerQueryRequest.AnswerGenerationSpec build()| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec |
|
buildPartial()
public AnswerQueryRequest.AnswerGenerationSpec buildPartial()| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec |
|
clear()
public AnswerQueryRequest.AnswerGenerationSpec.Builder clear()| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|
clearAnswerLanguageCode()
public AnswerQueryRequest.AnswerGenerationSpec.Builder clearAnswerLanguageCode()Language code for Answer. Use language tags defined by BCP47. Note: This is an experimental feature.
string answer_language_code = 4;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public AnswerQueryRequest.AnswerGenerationSpec.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|
clearIgnoreAdversarialQuery()
public AnswerQueryRequest.AnswerGenerationSpec.Builder clearIgnoreAdversarialQuery() 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;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
This builder for chaining. |
clearIgnoreNonAnswerSeekingQuery()
public AnswerQueryRequest.AnswerGenerationSpec.Builder clearIgnoreNonAnswerSeekingQuery() 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;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
This builder for chaining. |
clearIncludeCitations()
public AnswerQueryRequest.AnswerGenerationSpec.Builder clearIncludeCitations() Specifies whether to include citation metadata in the answer. The default
value is false.
bool include_citations = 3;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
This builder for chaining. |
clearModelSpec()
public AnswerQueryRequest.AnswerGenerationSpec.Builder clearModelSpec()Answer generation model specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public AnswerQueryRequest.AnswerGenerationSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|
clearPromptSpec()
public AnswerQueryRequest.AnswerGenerationSpec.Builder clearPromptSpec()Answer generation prompt specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|
clone()
public AnswerQueryRequest.AnswerGenerationSpec.Builder clone()| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|
getAnswerLanguageCode()
public String getAnswerLanguageCode()Language code for Answer. Use language tags defined by BCP47. Note: This is an experimental feature.
string answer_language_code = 4;
| Returns | |
|---|---|
| Type | Description |
String |
The answerLanguageCode. |
getAnswerLanguageCodeBytes()
public ByteString getAnswerLanguageCodeBytes()Language code for Answer. Use language tags defined by BCP47. Note: This is an experimental feature.
string answer_language_code = 4;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for answerLanguageCode. |
getDefaultInstanceForType()
public AnswerQueryRequest.AnswerGenerationSpec getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
The ignoreNonAnswerSeekingQuery. |
getIncludeCitations()
public boolean getIncludeCitations() Specifies whether to include citation metadata in the answer. The default
value is false.
bool include_citations = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
The includeCitations. |
getModelSpec()
public AnswerQueryRequest.AnswerGenerationSpec.ModelSpec getModelSpec()Answer generation model specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.ModelSpec |
The modelSpec. |
getModelSpecBuilder()
public AnswerQueryRequest.AnswerGenerationSpec.ModelSpec.Builder getModelSpecBuilder()Answer generation model specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.ModelSpec.Builder |
|
getModelSpecOrBuilder()
public AnswerQueryRequest.AnswerGenerationSpec.ModelSpecOrBuilder getModelSpecOrBuilder()Answer generation model specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.ModelSpecOrBuilder |
|
getPromptSpec()
public AnswerQueryRequest.AnswerGenerationSpec.PromptSpec getPromptSpec()Answer generation prompt specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.PromptSpec |
The promptSpec. |
getPromptSpecBuilder()
public AnswerQueryRequest.AnswerGenerationSpec.PromptSpec.Builder getPromptSpecBuilder()Answer generation prompt specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.PromptSpec.Builder |
|
getPromptSpecOrBuilder()
public AnswerQueryRequest.AnswerGenerationSpec.PromptSpecOrBuilder getPromptSpecOrBuilder()Answer generation prompt specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.PromptSpecOrBuilder |
|
hasModelSpec()
public boolean hasModelSpec()Answer generation model specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the modelSpec field is set. |
hasPromptSpec()
public boolean hasPromptSpec()Answer generation prompt specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the promptSpec field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(AnswerQueryRequest.AnswerGenerationSpec other)
public AnswerQueryRequest.AnswerGenerationSpec.Builder mergeFrom(AnswerQueryRequest.AnswerGenerationSpec other)| Parameter | |
|---|---|
| Name | Description |
other |
AnswerQueryRequest.AnswerGenerationSpec |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public AnswerQueryRequest.AnswerGenerationSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public AnswerQueryRequest.AnswerGenerationSpec.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|
mergeModelSpec(AnswerQueryRequest.AnswerGenerationSpec.ModelSpec value)
public AnswerQueryRequest.AnswerGenerationSpec.Builder mergeModelSpec(AnswerQueryRequest.AnswerGenerationSpec.ModelSpec value)Answer generation model specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
AnswerQueryRequest.AnswerGenerationSpec.ModelSpec |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|
mergePromptSpec(AnswerQueryRequest.AnswerGenerationSpec.PromptSpec value)
public AnswerQueryRequest.AnswerGenerationSpec.Builder mergePromptSpec(AnswerQueryRequest.AnswerGenerationSpec.PromptSpec value)Answer generation prompt specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
AnswerQueryRequest.AnswerGenerationSpec.PromptSpec |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AnswerQueryRequest.AnswerGenerationSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|
setAnswerLanguageCode(String value)
public AnswerQueryRequest.AnswerGenerationSpec.Builder setAnswerLanguageCode(String value)Language code for Answer. Use language tags defined by BCP47. Note: This is an experimental feature.
string answer_language_code = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe answerLanguageCode to set. |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
This builder for chaining. |
setAnswerLanguageCodeBytes(ByteString value)
public AnswerQueryRequest.AnswerGenerationSpec.Builder setAnswerLanguageCodeBytes(ByteString value)Language code for Answer. Use language tags defined by BCP47. Note: This is an experimental feature.
string answer_language_code = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for answerLanguageCode to set. |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public AnswerQueryRequest.AnswerGenerationSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|
setIgnoreAdversarialQuery(boolean value)
public AnswerQueryRequest.AnswerGenerationSpec.Builder setIgnoreAdversarialQuery(boolean value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe ignoreAdversarialQuery to set. |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
This builder for chaining. |
setIgnoreNonAnswerSeekingQuery(boolean value)
public AnswerQueryRequest.AnswerGenerationSpec.Builder setIgnoreNonAnswerSeekingQuery(boolean value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe ignoreNonAnswerSeekingQuery to set. |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
This builder for chaining. |
setIncludeCitations(boolean value)
public AnswerQueryRequest.AnswerGenerationSpec.Builder setIncludeCitations(boolean value) Specifies whether to include citation metadata in the answer. The default
value is false.
bool include_citations = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe includeCitations to set. |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
This builder for chaining. |
setModelSpec(AnswerQueryRequest.AnswerGenerationSpec.ModelSpec value)
public AnswerQueryRequest.AnswerGenerationSpec.Builder setModelSpec(AnswerQueryRequest.AnswerGenerationSpec.ModelSpec value)Answer generation model specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
AnswerQueryRequest.AnswerGenerationSpec.ModelSpec |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|
setModelSpec(AnswerQueryRequest.AnswerGenerationSpec.ModelSpec.Builder builderForValue)
public AnswerQueryRequest.AnswerGenerationSpec.Builder setModelSpec(AnswerQueryRequest.AnswerGenerationSpec.ModelSpec.Builder builderForValue)Answer generation model specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.ModelSpec model_spec = 1;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
AnswerQueryRequest.AnswerGenerationSpec.ModelSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|
setPromptSpec(AnswerQueryRequest.AnswerGenerationSpec.PromptSpec value)
public AnswerQueryRequest.AnswerGenerationSpec.Builder setPromptSpec(AnswerQueryRequest.AnswerGenerationSpec.PromptSpec value)Answer generation prompt specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
AnswerQueryRequest.AnswerGenerationSpec.PromptSpec |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|
setPromptSpec(AnswerQueryRequest.AnswerGenerationSpec.PromptSpec.Builder builderForValue)
public AnswerQueryRequest.AnswerGenerationSpec.Builder setPromptSpec(AnswerQueryRequest.AnswerGenerationSpec.PromptSpec.Builder builderForValue)Answer generation prompt specification.
.google.cloud.discoveryengine.v1beta.AnswerQueryRequest.AnswerGenerationSpec.PromptSpec prompt_spec = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
AnswerQueryRequest.AnswerGenerationSpec.PromptSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public AnswerQueryRequest.AnswerGenerationSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final AnswerQueryRequest.AnswerGenerationSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AnswerQueryRequest.AnswerGenerationSpec.Builder |
|