Class GoogleSearchRetrieval (1.0.0)

public final class GoogleSearchRetrieval extends GeneratedMessageV3 implements GoogleSearchRetrievalOrBuilder

Tool to retrieve public web data for grounding, powered by Google.

Protobuf type google.cloud.vertexai.v1.GoogleSearchRetrieval

Static Fields

DISABLE_ATTRIBUTION_FIELD_NUMBER

public static final int DISABLE_ATTRIBUTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GoogleSearchRetrieval getDefaultInstance()
Returns
Type Description
GoogleSearchRetrieval

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static GoogleSearchRetrieval.Builder newBuilder()
Returns
Type Description
GoogleSearchRetrieval.Builder

newBuilder(GoogleSearchRetrieval prototype)

public static GoogleSearchRetrieval.Builder newBuilder(GoogleSearchRetrieval prototype)
Parameter
Name Description
prototype GoogleSearchRetrieval
Returns
Type Description
GoogleSearchRetrieval.Builder

parseDelimitedFrom(InputStream input)

public static GoogleSearchRetrieval parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GoogleSearchRetrieval
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GoogleSearchRetrieval parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GoogleSearchRetrieval
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GoogleSearchRetrieval parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GoogleSearchRetrieval
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GoogleSearchRetrieval parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GoogleSearchRetrieval
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GoogleSearchRetrieval parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GoogleSearchRetrieval
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GoogleSearchRetrieval parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GoogleSearchRetrieval
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GoogleSearchRetrieval parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GoogleSearchRetrieval
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GoogleSearchRetrieval parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GoogleSearchRetrieval
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static GoogleSearchRetrieval parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GoogleSearchRetrieval
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GoogleSearchRetrieval parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GoogleSearchRetrieval
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GoogleSearchRetrieval parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GoogleSearchRetrieval
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GoogleSearchRetrieval parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GoogleSearchRetrieval
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<GoogleSearchRetrieval> parser()
Returns
Type Description
Parser<GoogleSearchRetrieval>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public GoogleSearchRetrieval getDefaultInstanceForType()
Returns
Type Description
GoogleSearchRetrieval

getDisableAttribution()

public boolean getDisableAttribution()

Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.

bool disable_attribution = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The disableAttribution.

getParserForType()

public Parser<GoogleSearchRetrieval> getParserForType()
Returns
Type Description
Parser<GoogleSearchRetrieval>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public GoogleSearchRetrieval.Builder newBuilderForType()
Returns
Type Description
GoogleSearchRetrieval.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GoogleSearchRetrieval.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GoogleSearchRetrieval.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public GoogleSearchRetrieval.Builder toBuilder()
Returns
Type Description
GoogleSearchRetrieval.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException