Interface VertexAISearchOrBuilder (3.68.0)

public interface VertexAISearchOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDataStoreSpecs(int index)

public abstract 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.v1beta1.VertexAISearch.DataStoreSpec data_store_specs = 5;

Parameter
Name Description
index int
Returns
Type Description
VertexAISearch.DataStoreSpec

getDataStoreSpecsCount()

public abstract 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.v1beta1.VertexAISearch.DataStoreSpec data_store_specs = 5;

Returns
Type Description
int

getDataStoreSpecsList()

public abstract 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.v1beta1.VertexAISearch.DataStoreSpec data_store_specs = 5;

Returns
Type Description
List<DataStoreSpec>

getDataStoreSpecsOrBuilder(int index)

public abstract 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.v1beta1.VertexAISearch.DataStoreSpec data_store_specs = 5;

Parameter
Name Description
index int
Returns
Type Description
VertexAISearch.DataStoreSpecOrBuilder

getDataStoreSpecsOrBuilderList()

public abstract 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.v1beta1.VertexAISearch.DataStoreSpec data_store_specs = 5;

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.VertexAISearch.DataStoreSpecOrBuilder>

getDatastore()

public abstract 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];

Returns
Type Description
String

The datastore.

getDatastoreBytes()

public abstract 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];

Returns
Type Description
ByteString

The bytes for datastore.

getEngine()

public abstract 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];

Returns
Type Description
String

The engine.

getEngineBytes()

public abstract 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];

Returns
Type Description
ByteString

The bytes for engine.

getFilter()

public abstract String getFilter()

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

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

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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

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

Returns
Type Description
ByteString

The bytes for filter.

getMaxResults()

public abstract 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];

Returns
Type Description
int

The maxResults.