- 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 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. |
clearIgnoreLowRelevantContent()
public AnswerQueryRequest.AnswerGenerationSpec.Builder clearIgnoreLowRelevantContent()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;
| 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. |
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
The ignoreLowRelevantContent. |
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 |
|
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the ignoreLowRelevantContent field is set. |
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. |
setIgnoreLowRelevantContent(boolean value)
public AnswerQueryRequest.AnswerGenerationSpec.Builder setIgnoreLowRelevantContent(boolean value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe ignoreLowRelevantContent 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 |
|