Send feedback
Class SearchRequest.ContentSearchSpec.SummarySpec (0.26.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.26.0 keyboard_arrow_down
public static final class SearchRequest . ContentSearchSpec . SummarySpec extends GeneratedMessageV3 implements SearchRequest . ContentSearchSpec . SummarySpecOrBuilder
A specification for configuring a summary returned in a search
response.
Protobuf type
google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
IGNORE_ADVERSARIAL_QUERY_FIELD_NUMBER
public static final int IGNORE_ADVERSARIAL_QUERY_FIELD_NUMBER
Field Value Type Description int
IGNORE_NON_SUMMARY_SEEKING_QUERY_FIELD_NUMBER
public static final int IGNORE_NON_SUMMARY_SEEKING_QUERY_FIELD_NUMBER
Field Value Type Description int
INCLUDE_CITATIONS_FIELD_NUMBER
public static final int INCLUDE_CITATIONS_FIELD_NUMBER
Field Value Type Description int
LANGUAGE_CODE_FIELD_NUMBER
public static final int LANGUAGE_CODE_FIELD_NUMBER
Field Value Type Description int
SUMMARY_RESULT_COUNT_FIELD_NUMBER
public static final int SUMMARY_RESULT_COUNT_FIELD_NUMBER
Field Value Type Description int
Static Methods
getDefaultInstance()
public static SearchRequest . ContentSearchSpec . SummarySpec getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static SearchRequest . ContentSearchSpec . SummarySpec . Builder newBuilder ()
newBuilder(SearchRequest.ContentSearchSpec.SummarySpec prototype)
public static SearchRequest . ContentSearchSpec . SummarySpec . Builder newBuilder ( SearchRequest . ContentSearchSpec . SummarySpec prototype )
parseDelimitedFrom(InputStream input)
public static SearchRequest . ContentSearchSpec . SummarySpec parseDelimitedFrom ( InputStream input )
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchRequest . ContentSearchSpec . SummarySpec parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static SearchRequest . ContentSearchSpec . SummarySpec parseFrom ( byte [] data )
Parameter Name Description data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest . ContentSearchSpec . SummarySpec parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static SearchRequest . ContentSearchSpec . SummarySpec parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest . ContentSearchSpec . SummarySpec parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
parseFrom(CodedInputStream input)
public static SearchRequest . ContentSearchSpec . SummarySpec parseFrom ( CodedInputStream input )
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchRequest . ContentSearchSpec . SummarySpec parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(InputStream input)
public static SearchRequest . ContentSearchSpec . SummarySpec parseFrom ( InputStream input )
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchRequest . ContentSearchSpec . SummarySpec parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static SearchRequest . ContentSearchSpec . SummarySpec parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest . ContentSearchSpec . SummarySpec parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<SearchRequest . ContentSearchSpec . SummarySpec> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description obj
Object
Overrides
getDefaultInstanceForType()
public SearchRequest . ContentSearchSpec . SummarySpec getDefaultInstanceForType ()
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 summary 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 summaries for adversarial queries and return
fallback messages instead.
bool ignore_adversarial_query = 3;
Returns Type Description boolean
The ignoreAdversarialQuery.
getIgnoreNonSummarySeekingQuery()
public boolean getIgnoreNonSummarySeekingQuery ()
Specifies whether to filter out queries that are not summary-seeking.
The default value is false
.
Google employs search-query classification to detect summary-seeking
queries. No summary is returned if the search query is classified as a
non-summary seeking query. For example, why is the sky blue
and Who
is the best soccer player in the world?
are summary-seeking queries,
but SFO airport
and world cup 2026
are not. They are most likely
navigational queries. If this field is set to true
, we skip
generating summaries for non-summary seeking queries and return
fallback messages instead.
bool ignore_non_summary_seeking_query = 4;
Returns Type Description boolean
The ignoreNonSummarySeekingQuery.
getIncludeCitations()
public boolean getIncludeCitations ()
Specifies whether to include citations in the summary. The default
value is false
.
When this field is set to true
, summaries include in-line citation
numbers.
Example summary including citations:
BigQuery is Google Cloud's fully managed and completely serverless
enterprise data warehouse [1]. BigQuery supports all data types, works
across clouds, and has built-in machine learning and business
intelligence, all within a unified platform [2, 3].
The citation numbers refer to the returned search results and are
1-indexed. For example, [1] means that the sentence is attributed to
the first search result. [2, 3] means that the sentence is attributed
to both the second and third search results.
bool include_citations = 2;
Returns Type Description boolean
The includeCitations.
getLanguageCode()
public String getLanguageCode ()
Language code for Summary. Use language tags defined by
BCP47 .
string language_code = 6;
Returns Type Description String
The languageCode.
getLanguageCodeBytes()
public ByteString getLanguageCodeBytes ()
Language code for Summary. Use language tags defined by
BCP47 .
string language_code = 6;
Returns Type Description ByteString
The bytes for languageCode.
getParserForType()
public Parser<SearchRequest . ContentSearchSpec . SummarySpec> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns Type Description int
Overrides
getSummaryResultCount()
public int getSummaryResultCount ()
The number of top results to generate the summary from. If the number
of results returned is less than summaryResultCount
, the summary is
generated from all of the results.
At most five results can be used to generate a summary.
int32 summary_result_count = 1;
Returns Type Description int
The summaryResultCount.
hashCode()
Returns Type Description int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public SearchRequest . ContentSearchSpec . SummarySpec . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchRequest . ContentSearchSpec . SummarySpec . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public SearchRequest . ContentSearchSpec . SummarySpec . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-19 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?
{"lastModified": "Last updated 2024-09-19 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-19 UTC."]]