Class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams

Search parameters.

Inheritance
object
GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1alpha.Data
Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll
Syntax
public class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams : IDirectResponseSchema

Properties

BoostSpec

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

Declaration
[JsonProperty("boostSpec")]
public virtual GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec BoostSpec { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec

CustomFineTuningSpec

Custom fine tuning configs.

Declaration
[JsonProperty("customFineTuningSpec")]
public virtual GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec CustomFineTuningSpec { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec

DataStoreSpecs

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.

Declaration
[JsonProperty("dataStoreSpecs")]
public virtual IList<GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec> DataStoreSpecs { get; set; }
Property Value
Type Description
IList<GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec>

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

Filter

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 --&gt; name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see Filter

Declaration
[JsonProperty("filter")]
public virtual string Filter { get; set; }
Property Value
Type Description
string

MaxReturnResults

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

Declaration
[JsonProperty("maxReturnResults")]
public virtual int? MaxReturnResults { get; set; }
Property Value
Type Description
int?

NaturalLanguageQueryUnderstandingSpec

Optional. Specification to enable natural language understanding capabilities for search requests.

Declaration
[JsonProperty("naturalLanguageQueryUnderstandingSpec")]
public virtual GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec NaturalLanguageQueryUnderstandingSpec { get; set; }
Property Value
Type Description
GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec

OrderBy

The order in which documents are returned. Documents can be ordered by a field in an 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.

Declaration
[JsonProperty("orderBy")]
public virtual string OrderBy { get; set; }
Property Value
Type Description
string

SearchResultMode

Specifies the search result mode. If unspecified, the search result mode defaults to DOCUMENTS. See parse and chunk documents

Declaration
[JsonProperty("searchResultMode")]
public virtual string SearchResultMode { get; set; }
Property Value
Type Description
string

Implements