Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GroundingSource::SearchSource (v1.2.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GroundingSource::SearchSource.

Message to be used for grounding with Vertex AI Search.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::String) — Filter expression to be applied to the search.

    The syntax is the same as SearchRequest.filter.

#filter=

def filter=(value) -> ::String
Parameter
  • value (::String) — Filter expression to be applied to the search.

    The syntax is the same as SearchRequest.filter.

Returns
  • (::String) — Filter expression to be applied to the search.

    The syntax is the same as SearchRequest.filter.

#max_result_count

def max_result_count() -> ::Integer
Returns
  • (::Integer) — Number of search results to return.

    The default value is 10. The maximumm allowed value is 10.

#max_result_count=

def max_result_count=(value) -> ::Integer
Parameter
  • value (::Integer) — Number of search results to return.

    The default value is 10. The maximumm allowed value is 10.

Returns
  • (::Integer) — Number of search results to return.

    The default value is 10. The maximumm allowed value is 10.

#safe_search

def safe_search() -> ::Boolean
Returns
  • (::Boolean) — If set, safe search is enabled in Vertex AI Search requests.

#safe_search=

def safe_search=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If set, safe search is enabled in Vertex AI Search requests.
Returns
  • (::Boolean) — If set, safe search is enabled in Vertex AI Search requests.

#serving_config

def serving_config() -> ::String
Returns
  • (::String) — The resource name of the Engine to use.

    Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}

#serving_config=

def serving_config=(value) -> ::String
Parameter
  • value (::String) — The resource name of the Engine to use.

    Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}

Returns
  • (::String) — The resource name of the Engine to use.

    Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}