Package com.google.cloud.discoveryengine.v1beta

Interface GenerateGroundedContentRequest.GroundingSource.SearchSourceOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GenerateGroundedContentRequest.GroundingSource.SearchSource, GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder
Enclosing class:
GenerateGroundedContentRequest.GroundingSource
public static interface GenerateGroundedContentRequest.GroundingSource.SearchSourceOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Filter expression to be applied to the search.
    com.google.protobuf.ByteString
    getFilterBytes()
    Filter expression to be applied to the search.
    int
    getMaxResultCount()
    Number of search results to return.
    boolean
    getSafeSearch()
    If set, safe search is enabled in Vertex AI Search requests.
    String
    getServingConfig()
    The resource name of the Engine to use.
    com.google.protobuf.ByteString
    getServingConfigBytes()
    The resource name of the Engine to use.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getServingConfig

      String getServingConfig()
       The resource name of the Engine to use.

 Format:
 `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
      string serving_config = 1 [(.google.api.resource_reference) = { ... }
      Returns:
      The servingConfig.

    • getServingConfigBytes

      com.google.protobuf.ByteString getServingConfigBytes()
       The resource name of the Engine to use.

 Format:
 `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
      string serving_config = 1 [(.google.api.resource_reference) = { ... }
      Returns:
      The bytes for servingConfig.

    • getMaxResultCount

      int getMaxResultCount()
       Number of search results to return.

 The default value is 10. The maximumm allowed value is 10.
      int32 max_result_count = 2;
      Returns:
      The maxResultCount.

    • getFilter

      String getFilter()
       Filter expression to be applied to the search.

 The syntax is the same as
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter].
      string filter = 3;
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Filter expression to be applied to the search.

 The syntax is the same as
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter].
      string filter = 3;
      Returns:
      The bytes for filter.

    • getSafeSearch

      boolean getSafeSearch()
       If set, safe search is enabled in Vertex AI Search requests.
      bool safe_search = 5;
      Returns:
      The safeSearch.