Class GoogleSearchRetrieval (3.41.0)

public final class GoogleSearchRetrieval extends GeneratedMessageV3 implements GoogleSearchRetrievalOrBuilder

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

Protobuf type google.cloud.aiplatform.v1.GoogleSearchRetrieval

Static Fields

DISABLE_ATTRIBUTION_FIELD_NUMBER

public static final int DISABLE_ATTRIBUTION_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static GoogleSearchRetrieval getDefaultInstance()
Returns
TypeDescription
GoogleSearchRetrieval

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static GoogleSearchRetrieval.Builder newBuilder()
Returns
TypeDescription
GoogleSearchRetrieval.Builder

newBuilder(GoogleSearchRetrieval prototype)

public static GoogleSearchRetrieval.Builder newBuilder(GoogleSearchRetrieval prototype)
Parameter
NameDescription
prototypeGoogleSearchRetrieval
Returns
TypeDescription
GoogleSearchRetrieval.Builder

parseDelimitedFrom(InputStream input)

public static GoogleSearchRetrieval parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GoogleSearchRetrieval
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GoogleSearchRetrieval parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GoogleSearchRetrieval
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static GoogleSearchRetrieval parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
GoogleSearchRetrieval
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GoogleSearchRetrieval parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GoogleSearchRetrieval
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GoogleSearchRetrieval parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
GoogleSearchRetrieval
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GoogleSearchRetrieval parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GoogleSearchRetrieval
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GoogleSearchRetrieval parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
GoogleSearchRetrieval
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GoogleSearchRetrieval parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GoogleSearchRetrieval
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static GoogleSearchRetrieval parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GoogleSearchRetrieval
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GoogleSearchRetrieval parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GoogleSearchRetrieval
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static GoogleSearchRetrieval parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
GoogleSearchRetrieval
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GoogleSearchRetrieval parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GoogleSearchRetrieval
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<GoogleSearchRetrieval> parser()
Returns
TypeDescription
Parser<GoogleSearchRetrieval>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public GoogleSearchRetrieval getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
boolean

The disableAttribution.

getParserForType()

public Parser<GoogleSearchRetrieval> getParserForType()
Returns
TypeDescription
Parser<GoogleSearchRetrieval>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public GoogleSearchRetrieval.Builder newBuilderForType()
Returns
TypeDescription
GoogleSearchRetrieval.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GoogleSearchRetrieval.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
GoogleSearchRetrieval.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public GoogleSearchRetrieval.Builder toBuilder()
Returns
TypeDescription
GoogleSearchRetrieval.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException