public static final class GenerateGroundedContentRequest.GroundingSource.SearchSource extends GeneratedMessage implements GenerateGroundedContentRequest.GroundingSource.SearchSourceOrBuilder
Message to be used for grounding with Vertex AI Search.
Protobuf type
google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSource.SearchSource
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MAX_RESULT_COUNT_FIELD_NUMBER
public static final int MAX_RESULT_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SAFE_SEARCH_FIELD_NUMBER
public static final int SAFE_SEARCH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SERVING_CONFIG_FIELD_NUMBER
public static final int SERVING_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static GenerateGroundedContentRequest.GroundingSource.SearchSource getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder newBuilder()
newBuilder(GenerateGroundedContentRequest.GroundingSource.SearchSource prototype)
public static GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder newBuilder(GenerateGroundedContentRequest.GroundingSource.SearchSource prototype)
parseDelimitedFrom(InputStream input)
public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseDelimitedFrom(InputStream input)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
parseFrom(CodedInputStream input)
public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseFrom(CodedInputStream input)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(InputStream input)
public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseFrom(InputStream input)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<GenerateGroundedContentRequest.GroundingSource.SearchSource> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public GenerateGroundedContentRequest.GroundingSource.SearchSource getDefaultInstanceForType()
getFilter()
public String getFilter()
Filter expression to be applied to the search.
The syntax is the same as
SearchRequest.filter.
string filter = 3;
| Returns |
| Type |
Description |
String |
The filter.
|
getFilterBytes()
public ByteString getFilterBytes()
Filter expression to be applied to the search.
The syntax is the same as
SearchRequest.filter.
string filter = 3;
| Returns |
| Type |
Description |
ByteString |
The bytes for filter.
|
getMaxResultCount()
public int getMaxResultCount()
Number of search results to return.
The default value is 10. The maximumm allowed value is 10.
int32 max_result_count = 2;
| Returns |
| Type |
Description |
int |
The maxResultCount.
|
getParserForType()
public Parser<GenerateGroundedContentRequest.GroundingSource.SearchSource> getParserForType()
Overrides
getSafeSearch()
public boolean getSafeSearch()
If set, safe search is enabled in Vertex AI Search requests.
bool safe_search = 5;
| Returns |
| Type |
Description |
boolean |
The safeSearch.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getServingConfig()
public String getServingConfig()
The resource name of the Engine to use.
Format:
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}
string serving_config = 1 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The servingConfig.
|
getServingConfigBytes()
public ByteString getServingConfigBytes()
The resource name of the Engine to use.
Format:
projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}
string serving_config = 1 [(.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for servingConfig.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
