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

      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

      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.

    • 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}`

    • 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}`

    • filter

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

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

    • 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.

    • build

      public abstract VertexAISearch build()