Class VertexAISearch

  • All Implemented Interfaces:

    
    public abstract class VertexAISearch
    extends JsonSerializable
                        

    Retrieve from Vertex AI Search datastore or engine for grounding. datastore and engine are mutually exclusive. See https://cloud.google.com/products/agent-builder. This data type is not supported in Gemini API.

    • Constructor Detail

      • VertexAISearch

        VertexAISearch()
    • Method Detail

      • dataStoreSpecs

         abstract Optional<List<VertexAISearchDataStoreSpec>> 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

         abstract Optional<String> datastore()

        Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`

      • engine

         abstract Optional<String> engine()

        Optional. Fully-qualified Vertex AI Search engine resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`

      • filter

         abstract Optional<String> filter()

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

      • maxResults

         abstract Optional<Integer> maxResults()

        Optional. Number of search results to return per query. The default value is 10. The maximumm allowed value is 10.