Package com.google.genai.types

Class VertexAISearch.Builder

java.lang.Object
com.google.genai.types.VertexAISearch.Builder
Enclosing class:
VertexAISearch
public abstract static class VertexAISearch.Builder extends Object
Builder for VertexAISearch.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • dataStoreSpecs

      public 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 public VertexAISearch.Builder dataStoreSpecs(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 public VertexAISearch.Builder dataStoreSpecs(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 public VertexAISearch.Builder clearDataStoreSpecs()
      Clears the value of dataStoreSpecs field.

    • datastore

      public 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 public VertexAISearch.Builder clearDatastore()
      Clears the value of datastore field.

    • engine

      public 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 public VertexAISearch.Builder clearEngine()
      Clears the value of engine field.

    • filter

      public abstract VertexAISearch.Builder filter(String filter)
      Setter for filter.

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

    • clearFilter

      @CanIgnoreReturnValue public VertexAISearch.Builder clearFilter()
      Clears the value of filter field.

    • maxResults

      public 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 public VertexAISearch.Builder clearMaxResults()
      Clears the value of maxResults field.

    • build

      public abstract VertexAISearch build()