Interface StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder (0.66.0)

public static interface StreamAssistRequest.ToolsSpec.VertexAiSearchSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDataStoreSpecs(int index)

public abstract SearchRequest.DataStoreSpec getDataStoreSpecs(int index)

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
SearchRequest.DataStoreSpec

getDataStoreSpecsCount()

public abstract int getDataStoreSpecsCount()

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getDataStoreSpecsList()

public abstract List<SearchRequest.DataStoreSpec> getDataStoreSpecsList()

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<DataStoreSpec>

getDataStoreSpecsOrBuilder(int index)

public abstract SearchRequest.DataStoreSpecOrBuilder getDataStoreSpecsOrBuilder(int index)

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
SearchRequest.DataStoreSpecOrBuilder

getDataStoreSpecsOrBuilderList()

public abstract List<? extends SearchRequest.DataStoreSpecOrBuilder> getDataStoreSpecsOrBuilderList()

Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores.

repeated .google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpec data_store_specs = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.SearchRequest.DataStoreSpecOrBuilder>

getFilter()

public abstract String getFilter()

Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")'

For more information about filtering including syntax and filter operators, see Filter

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

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")'

For more information about filtering including syntax and filter operators, see Filter

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

Returns
Type Description
ByteString

The bytes for filter.