Discovery Engine v1 API - Class AnswerQueryRequest.Types.SearchSpec.Types.SearchParams (1.3.0) 

public sealed class AnswerQueryRequest.Types.SearchSpec.Types.SearchParams : IMessage<AnswerQueryRequest.Types.SearchSpec.Types.SearchParams>, IEquatable<AnswerQueryRequest.Types.SearchSpec.Types.SearchParams>, IDeepCloneable<AnswerQueryRequest.Types.SearchSpec.Types.SearchParams>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class AnswerQueryRequest.Types.SearchSpec.Types.SearchParams.

Search parameters.

Inheritance

object > AnswerQueryRequest.Types.SearchSpec.Types.SearchParams

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

SearchParams()

public SearchParams()

SearchParams(SearchParams)

public SearchParams(AnswerQueryRequest.Types.SearchSpec.Types.SearchParams other)
Parameter
Name Description
other AnswerQueryRequestTypesSearchSpecTypesSearchParams

Properties

BoostSpec

public SearchRequest.Types.BoostSpec BoostSpec { get; set; }

Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see Boosting

Property Value
Type Description
SearchRequestTypesBoostSpec

DataStoreSpecs

public RepeatedField<SearchRequest.Types.DataStoreSpec> DataStoreSpecs { get; }

Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.

Property Value
Type Description
RepeatedFieldSearchRequestTypesDataStoreSpec

Filter

public string Filter { get; set; }

The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response.

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")'

For more information about filtering including syntax and filter operators, see Filter

Property Value
Type Description
string

MaxReturnResults

public int MaxReturnResults { get; set; }

Number of search results to return. The default value is 10.

Property Value
Type Description
int

OrderBy

public string OrderBy { get; set; }

The order in which documents are returned. Documents can be ordered by a field in an [Document][google.cloud.discoveryengine.v1.Document] object. Leave it unset if ordered by relevance. order_by expression is case-sensitive. For more information on ordering, see Ordering

If this field is unrecognizable, an INVALID_ARGUMENT is returned.

Property Value
Type Description
string

SearchResultMode

public SearchRequest.Types.ContentSearchSpec.Types.SearchResultMode SearchResultMode { get; set; }

Specifies the search result mode. If unspecified, the search result mode is based on [DataStore.DocumentProcessingConfig.chunking_config][]:

  • If [DataStore.DocumentProcessingConfig.chunking_config][] is specified, it defaults to CHUNKS.
  • Otherwise, it defaults to DOCUMENTS. See parse and chunk documents
Property Value
Type Description
SearchRequestTypesContentSearchSpecTypesSearchResultMode