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 v1beta API class AnswerQueryRequest.Types.SearchSpec.Types.SearchParams.
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
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.
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
The order in which documents are returned. Documents can be ordered
by a field in an
[Document][google.cloud.discoveryengine.v1beta.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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["\u003cp\u003eThis document provides reference information for the \u003ccode\u003eAnswerQueryRequest.Types.SearchSpec.Types.SearchParams\u003c/code\u003e class within the Google Cloud Discovery Engine v1beta API.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eSearchParams\u003c/code\u003e class is used to define parameters for search operations, including filtering, ordering, and result boosting, within the context of an answer query.\u003c/p\u003e\n"],["\u003cp\u003eIt inherits from \u003ccode\u003eobject\u003c/code\u003e and implements several interfaces such as \u003ccode\u003eIMessage\u003c/code\u003e, \u003ccode\u003eIEquatable\u003c/code\u003e, \u003ccode\u003eIDeepCloneable\u003c/code\u003e, and \u003ccode\u003eIBufferMessage\u003c/code\u003e, enabling various functionalities like serialization, comparison, and deep cloning.\u003c/p\u003e\n"],["\u003cp\u003eKey properties of \u003ccode\u003eSearchParams\u003c/code\u003e include \u003ccode\u003eFilter\u003c/code\u003e for defining search filters, \u003ccode\u003eOrderBy\u003c/code\u003e for specifying result order, \u003ccode\u003eMaxReturnResults\u003c/code\u003e for the maximum number of results, and \u003ccode\u003eBoostSpec\u003c/code\u003e for document boosting.\u003c/p\u003e\n"],["\u003cp\u003eThe class also allows for specifying multiple data stores to filter on, as specified by the \u003ccode\u003eDataStoreSpecs\u003c/code\u003e property, if there are more than one data stores associated with the engine.\u003c/p\u003e\n"]]],[],null,["# Discovery Engine v1beta API - Class AnswerQueryRequest.Types.SearchSpec.Types.SearchParams (1.0.0-beta19)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.0-beta19 (latest)](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.AnswerQueryRequest.Types.SearchSpec.Types.SearchParams)\n- [1.0.0-beta18](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/1.0.0-beta18/Google.Cloud.DiscoveryEngine.V1Beta.AnswerQueryRequest.Types.SearchSpec.Types.SearchParams) \n\n public sealed class AnswerQueryRequest.Types.SearchSpec.Types.SearchParams : IMessage\u003cAnswerQueryRequest.Types.SearchSpec.Types.SearchParams\u003e, IEquatable\u003cAnswerQueryRequest.Types.SearchSpec.Types.SearchParams\u003e, IDeepCloneable\u003cAnswerQueryRequest.Types.SearchSpec.Types.SearchParams\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Discovery Engine v1beta API class AnswerQueryRequest.Types.SearchSpec.Types.SearchParams.\n\nSearch parameters. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e AnswerQueryRequest.Types.SearchSpec.Types.SearchParams \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[AnswerQueryRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.AnswerQueryRequest)[Types](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.AnswerQueryRequest.Types)[SearchSpec](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.AnswerQueryRequest.Types.SearchSpec)[Types](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.AnswerQueryRequest.Types.SearchSpec.Types)[SearchParams](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.AnswerQueryRequest.Types.SearchSpec.Types.SearchParams), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[AnswerQueryRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.AnswerQueryRequest)[Types](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.AnswerQueryRequest.Types)[SearchSpec](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.AnswerQueryRequest.Types.SearchSpec)[Types](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.AnswerQueryRequest.Types.SearchSpec.Types)[SearchParams](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.AnswerQueryRequest.Types.SearchSpec.Types.SearchParams), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[AnswerQueryRequest](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.AnswerQueryRequest)[Types](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.AnswerQueryRequest.Types)[SearchSpec](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.AnswerQueryRequest.Types.SearchSpec)[Types](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.AnswerQueryRequest.Types.SearchSpec.Types)[SearchParams](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.AnswerQueryRequest.Types.SearchSpec.Types.SearchParams), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.DiscoveryEngine.V1Beta](/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta)\n\nAssembly\n--------\n\nGoogle.Cloud.DiscoveryEngine.V1Beta.dll\n\nConstructors\n------------\n\n### SearchParams()\n\n public SearchParams()\n\n### SearchParams(SearchParams)\n\n public SearchParams(AnswerQueryRequest.Types.SearchSpec.Types.SearchParams other)\n\nProperties\n----------\n\n### BoostSpec\n\n public SearchRequest.Types.BoostSpec BoostSpec { get; set; }\n\nBoost specification to boost certain documents in search results which\nmay affect the answer query response. For more information on boosting,\nsee [Boosting](https://cloud.google.com/retail/docs/boosting#boost)\n\n### DataStoreSpecs\n\n public RepeatedField\u003cSearchRequest.Types.DataStoreSpec\u003e DataStoreSpecs { get; }\n\nSpecs defining dataStores to filter on in a search call and\nconfigurations for those dataStores. This is only considered for\nengines with multiple dataStores use case. For single dataStore within\nan engine, they should use the specs at the top level.\n\n### Filter\n\n public string Filter { get; set; }\n\nThe filter syntax consists of an expression language for constructing\na predicate from one or more fields of the documents being filtered.\nFilter expression is case-sensitive. This will be used to filter\nsearch results which may affect the Answer response.\n\nIf this field is unrecognizable, an `INVALID_ARGUMENT` is returned.\n\nFiltering in Vertex AI Search is done by mapping the LHS filter key\nto a key property defined in the Vertex AI Search backend -- this\nmapping is defined by the customer in their schema. For example a\nmedia customers might have a field 'name' in their schema. In this\ncase the filter would look like this: filter --\\\u003e name:'ANY(\"king\nkong\")'\n\nFor more information about filtering including syntax and filter\noperators, see\n[Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)\n\n### MaxReturnResults\n\n public int MaxReturnResults { get; set; }\n\nNumber of search results to return.\nThe default value is 10.\n\n### NaturalLanguageQueryUnderstandingSpec\n\n public SearchRequest.Types.NaturalLanguageQueryUnderstandingSpec NaturalLanguageQueryUnderstandingSpec { get; set; }\n\nOptional. Specification to enable natural language understanding\ncapabilities for search requests.\n\n### OrderBy\n\n public string OrderBy { get; set; }\n\nThe order in which documents are returned. Documents can be ordered\nby a field in an\n\\[Document\\]\\[google.cloud.discoveryengine.v1beta.Document\\] object. Leave\nit unset if ordered by relevance. `order_by` expression is\ncase-sensitive. For more information on ordering, see\n[Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)\n\nIf this field is unrecognizable, an `INVALID_ARGUMENT` is returned.\n\n### SearchResultMode\n\n public SearchRequest.Types.ContentSearchSpec.Types.SearchResultMode SearchResultMode { get; set; }\n\nSpecifies the search result mode. If unspecified, the\nsearch result mode defaults to `DOCUMENTS`.\nSee [parse and chunk\ndocuments](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)"]]
