Class VertexAISearch.Builder
-
- All Implemented Interfaces:
public abstract class VertexAISearch.BuilderBuilder for VertexAISearch.
-
-
Constructor Summary
Constructors Constructor Description VertexAISearch.Builder()
-
Method Summary
Modifier and Type Method Description abstract VertexAISearch.BuilderdataStoreSpecs(List<VertexAISearchDataStoreSpec> dataStoreSpecs)Setter for dataStoreSpecs. VertexAISearch.BuilderdataStoreSpecs(Array<VertexAISearchDataStoreSpec> dataStoreSpecs)Setter for dataStoreSpecs. VertexAISearch.BuilderdataStoreSpecs(Array<VertexAISearchDataStoreSpec.Builder> dataStoreSpecsBuilders)Setter for dataStoreSpecs builder. VertexAISearch.BuilderclearDataStoreSpecs()Clears the value of dataStoreSpecs field. abstract VertexAISearch.Builderdatastore(String datastore)Setter for datastore. VertexAISearch.BuilderclearDatastore()Clears the value of datastore field. abstract VertexAISearch.Builderengine(String engine)Setter for engine. VertexAISearch.BuilderclearEngine()Clears the value of engine field. abstract VertexAISearch.Builderfilter(String filter)Setter for filter. VertexAISearch.BuilderclearFilter()Clears the value of filter field. abstract VertexAISearch.BuildermaxResults(Integer maxResults)Setter for maxResults. VertexAISearch.BuilderclearMaxResults()Clears the value of maxResults field. abstract VertexAISearchbuild()-
-
Method Detail
-
dataStoreSpecs
abstract VertexAISearch.Builder dataStoreSpecs(List<VertexAISearchDataStoreSpec> dataStoreSpecs)
Setter for dataStoreSpecs.
dataStoreSpecs: 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.
-
dataStoreSpecs
@CanIgnoreReturnValue() VertexAISearch.Builder dataStoreSpecs(Array<VertexAISearchDataStoreSpec> dataStoreSpecs)
Setter for dataStoreSpecs.
dataStoreSpecs: 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.
-
dataStoreSpecs
@CanIgnoreReturnValue() VertexAISearch.Builder dataStoreSpecs(Array<VertexAISearchDataStoreSpec.Builder> dataStoreSpecsBuilders)
Setter for dataStoreSpecs builder.
dataStoreSpecs: 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.
-
clearDataStoreSpecs
@CanIgnoreReturnValue() VertexAISearch.Builder clearDataStoreSpecs()
Clears the value of dataStoreSpecs field.
-
datastore
abstract VertexAISearch.Builder datastore(String datastore)
Setter for datastore.
datastore: Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
-
clearDatastore
@CanIgnoreReturnValue() VertexAISearch.Builder clearDatastore()
Clears the value of datastore field.
-
engine
abstract VertexAISearch.Builder engine(String engine)
Setter for engine.
engine: Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
-
clearEngine
@CanIgnoreReturnValue() VertexAISearch.Builder clearEngine()
Clears the value of engine field.
-
filter
abstract VertexAISearch.Builder filter(String filter)
Setter for filter.
filter: Optional. Filter strings to be passed to the search API.
-
clearFilter
@CanIgnoreReturnValue() VertexAISearch.Builder clearFilter()
Clears the value of filter field.
-
maxResults
abstract VertexAISearch.Builder maxResults(Integer maxResults)
Setter for maxResults.
maxResults: Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.
-
clearMaxResults
@CanIgnoreReturnValue() VertexAISearch.Builder clearMaxResults()
Clears the value of maxResults field.
-
build
abstract VertexAISearch build()
-
-
-
-