com.google.cloud.aiplatform.v1

Class VertexAISearch

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1.VertexAISearch

All Implemented Interfaces:

VertexAISearchOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class VertexAISearch
extends com.google.protobuf.GeneratedMessageV3
implements VertexAISearchOrBuilder

 Retrieve from Vertex AI Search datastore or engine for grounding.
 datastore and engine are mutually exclusive.
 See https://cloud.google.com/products/agent-builder
 

Protobuf type google.cloud.aiplatform.v1.VertexAISearch

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VertexAISearch.Builder Retrieve from Vertex AI Search datastore or engine for grounding.
static class	VertexAISearch.DataStoreSpec Define data stores within engine to filter on in a search call and configurations for those data stores.
static interface	VertexAISearch.DataStoreSpecOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATA_STORE_SPECS_FIELD_NUMBER
static int	DATASTORE_FIELD_NUMBER
static int	ENGINE_FIELD_NUMBER
static int	FILTER_FIELD_NUMBER
static int	MAX_RESULTS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDatastore() Optional.
com.google.protobuf.ByteString	getDatastoreBytes() Optional.
VertexAISearch.DataStoreSpec	getDataStoreSpecs(int index) Specifications that define the specific DataStores to be searched, along with configurations for those data stores.
int	getDataStoreSpecsCount() Specifications that define the specific DataStores to be searched, along with configurations for those data stores.
List<VertexAISearch.DataStoreSpec>	getDataStoreSpecsList() Specifications that define the specific DataStores to be searched, along with configurations for those data stores.
VertexAISearch.DataStoreSpecOrBuilder	getDataStoreSpecsOrBuilder(int index) Specifications that define the specific DataStores to be searched, along with configurations for those data stores.
List<? extends VertexAISearch.DataStoreSpecOrBuilder>	getDataStoreSpecsOrBuilderList() Specifications that define the specific DataStores to be searched, along with configurations for those data stores.
static VertexAISearch	getDefaultInstance()
VertexAISearch	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getEngine() Optional.
com.google.protobuf.ByteString	getEngineBytes() Optional.
String	getFilter() Optional.
com.google.protobuf.ByteString	getFilterBytes() Optional.
int	getMaxResults() Optional.
com.google.protobuf.Parser<VertexAISearch>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static VertexAISearch.Builder	newBuilder()
static VertexAISearch.Builder	newBuilder(VertexAISearch prototype)
VertexAISearch.Builder	newBuilderForType()
protected VertexAISearch.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static VertexAISearch	parseDelimitedFrom(InputStream input)
static VertexAISearch	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static VertexAISearch	parseFrom(byte[] data)
static VertexAISearch	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static VertexAISearch	parseFrom(ByteBuffer data)
static VertexAISearch	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static VertexAISearch	parseFrom(com.google.protobuf.ByteString data)
static VertexAISearch	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static VertexAISearch	parseFrom(com.google.protobuf.CodedInputStream input)
static VertexAISearch	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static VertexAISearch	parseFrom(InputStream input)
static VertexAISearch	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<VertexAISearch>	parser()
VertexAISearch.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

DATASTORE_FIELD_NUMBER

public static final int DATASTORE_FIELD_NUMBER

See Also:

Constant Field Values

ENGINE_FIELD_NUMBER

public static final int ENGINE_FIELD_NUMBER

See Also:

Constant Field Values

MAX_RESULTS_FIELD_NUMBER

public static final int MAX_RESULTS_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

DATA_STORE_SPECS_FIELD_NUMBER

public static final int DATA_STORE_SPECS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getDatastore

public String getDatastore()

 Optional. Fully-qualified Vertex AI Search data store resource ID.
 Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
 

string datastore = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDatastore in interface VertexAISearchOrBuilder

Returns:

The datastore.

getDatastoreBytes

public com.google.protobuf.ByteString getDatastoreBytes()

 Optional. Fully-qualified Vertex AI Search data store resource ID.
 Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
 

string datastore = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDatastoreBytes in interface VertexAISearchOrBuilder

Returns:

The bytes for datastore.

getEngine

public String getEngine()

 Optional. Fully-qualified Vertex AI Search engine resource ID.
 Format:
 `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
 

string engine = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getEngine in interface VertexAISearchOrBuilder

Returns:

The engine.

getEngineBytes

public com.google.protobuf.ByteString getEngineBytes()

 Optional. Fully-qualified Vertex AI Search engine resource ID.
 Format:
 `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
 

string engine = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getEngineBytes in interface VertexAISearchOrBuilder

Returns:

The bytes for engine.

getMaxResults

public int getMaxResults()

 Optional. Number of search results to return per query.
 The default value is 10.
 The maximumm allowed value is 10.
 

int32 max_results = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getMaxResults in interface VertexAISearchOrBuilder

Returns:

The maxResults.

getFilter

public String getFilter()

 Optional. Filter strings to be passed to the search API.
 

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFilter in interface VertexAISearchOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 Optional. Filter strings to be passed to the search API.
 

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFilterBytes in interface VertexAISearchOrBuilder

Returns:

The bytes for filter.

getDataStoreSpecsList

public List<VertexAISearch.DataStoreSpec> getDataStoreSpecsList()

 Specifications that define the specific DataStores to be searched, along
 with configurations for those data stores. This is only considered for
 Engines with multiple data stores.
 It should only be set if engine is used.
 

repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;

Specified by:

getDataStoreSpecsList in interface VertexAISearchOrBuilder

getDataStoreSpecsOrBuilderList

public List<? extends VertexAISearch.DataStoreSpecOrBuilder> getDataStoreSpecsOrBuilderList()

 Specifications that define the specific DataStores to be searched, along
 with configurations for those data stores. This is only considered for
 Engines with multiple data stores.
 It should only be set if engine is used.
 

repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;

Specified by:

getDataStoreSpecsOrBuilderList in interface VertexAISearchOrBuilder

getDataStoreSpecsCount

public int getDataStoreSpecsCount()

 Specifications that define the specific DataStores to be searched, along
 with configurations for those data stores. This is only considered for
 Engines with multiple data stores.
 It should only be set if engine is used.
 

repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;

Specified by:

getDataStoreSpecsCount in interface VertexAISearchOrBuilder

getDataStoreSpecs

public VertexAISearch.DataStoreSpec getDataStoreSpecs(int index)

 Specifications that define the specific DataStores to be searched, along
 with configurations for those data stores. This is only considered for
 Engines with multiple data stores.
 It should only be set if engine is used.
 

repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;

Specified by:

getDataStoreSpecs in interface VertexAISearchOrBuilder

getDataStoreSpecsOrBuilder

public VertexAISearch.DataStoreSpecOrBuilder getDataStoreSpecsOrBuilder(int index)

 Specifications that define the specific DataStores to be searched, along
 with configurations for those data stores. This is only considered for
 Engines with multiple data stores.
 It should only be set if engine is used.
 

repeated .google.cloud.aiplatform.v1.VertexAISearch.DataStoreSpec data_store_specs = 5;

Specified by:

getDataStoreSpecsOrBuilder in interface VertexAISearchOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static VertexAISearch parseFrom(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static VertexAISearch parseFrom(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static VertexAISearch parseFrom(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static VertexAISearch parseFrom(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static VertexAISearch parseFrom(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static VertexAISearch parseFrom(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static VertexAISearch parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static VertexAISearch parseFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static VertexAISearch parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static VertexAISearch parseDelimitedFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseFrom

public static VertexAISearch parseFrom(com.google.protobuf.CodedInputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static VertexAISearch parseFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

newBuilderForType

public VertexAISearch.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static VertexAISearch.Builder newBuilder()

newBuilder

public static VertexAISearch.Builder newBuilder(VertexAISearch prototype)

toBuilder

public VertexAISearch.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected VertexAISearch.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static VertexAISearch getDefaultInstance()

parser

public static com.google.protobuf.Parser<VertexAISearch> parser()

getParserForType

public com.google.protobuf.Parser<VertexAISearch> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public VertexAISearch getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder