1.0.0-beta25 (latest) 1.0.0-beta24

    public sealed class SearchRequest : IMessage<SearchRequest>, IEquatable<SearchRequest>, IDeepCloneable<SearchRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Discovery Engine v1beta API class SearchRequest.

Request message for
\[SearchService.Search\]\[google.cloud.discoveryengine.v1beta.SearchService.Search\]
method.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> SearchRequest

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[SearchRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[SearchRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[SearchRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest), [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), [IPageRequest](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Grpc.IPageRequest.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.DiscoveryEngine.V1Beta](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta)

## Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

## Constructors

### SearchRequest()

    public SearchRequest()

### SearchRequest(SearchRequest)

    public SearchRequest(SearchRequest other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest` |

## Properties

### BoostSpec

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

Boost specification to boost certain documents.
For more information on boosting, see
[Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.BoostSpec` |   |

### Branch

    public string Branch { get; set; }

The branch resource name, such as
`projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.

Use `default_branch` as the branch ID or leave this field empty, to search
documents under the default branch.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### BranchAsBranchName

    public BranchName BranchAsBranchName { get; set; }

[BranchName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BranchName)-typed view over the [Branch](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest#Google_Cloud_DiscoveryEngine_V1Beta_SearchRequest_Branch) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BranchName` |   |

### CanonicalFilter

    public string CanonicalFilter { get; set; }

The default filter that is applied when a user performs a search without
checking any filters on the search page.

The filter applied to every search request when quality improvement such as
query expansion is needed. In the case a query does not have a sufficient
amount of results this filter will be used to determine whether or not to
enable the query expansion flow. The original filter will still be used for
the query expanded search.
This field is strongly recommended to achieve high search quality.

For more information about filter syntax, see
\[SearchRequest.filter\]\[google.cloud.discoveryengine.v1beta.SearchRequest.filter\].

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### ContentSearchSpec

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

A specification for configuring the behavior of content search.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.ContentSearchSpec` |   |

### CrowdingSpecs

    public RepeatedField<SearchRequest.Types.CrowdingSpec> CrowdingSpecs { get; }

Optional. Crowding specifications for improving result diversity.
If multiple CrowdingSpecs are specified, crowding will be evaluated on
each unique combination of the `field` values, and max_count will be the
maximum value of `max_count` across all CrowdingSpecs.
For example, if the first CrowdingSpec has `field` = "color" and
`max_count` = 3, and the second CrowdingSpec has `field` = "size" and
`max_count` = 2, then after 3 documents that share the same color AND size
have been returned, subsequent ones should be
removed or demoted.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.CrowdingSpec` |   |

### CustomRankingParams

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

Optional. Optional configuration for the Custom Ranking feature.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.CustomRankingParams` |   |

### DataStoreSpecs

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

Specifications that define the specific
\[DataStore\]\[google.cloud.discoveryengine.v1beta.DataStore\]s to be searched,
along with configurations for those data stores. This is only considered
for \[Engine\]\[google.cloud.discoveryengine.v1beta.Engine\]s with multiple
data stores. For engines with a single data store, the specs directly under
\[SearchRequest\]\[google.cloud.discoveryengine.v1beta.SearchRequest\] should
be used.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.DataStoreSpec` |   |

### DisplaySpec

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

Optional. Config for display feature, like match highlighting on search
results.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.DisplaySpec` |   |

### EmbeddingSpec

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

Uses the provided embedding to do additional semantic document retrieval.
The retrieval is based on the dot product of
\[SearchRequest.EmbeddingSpec.EmbeddingVector.vector\]\[google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector\]
and the document embedding that is provided in
\[SearchRequest.EmbeddingSpec.EmbeddingVector.field_path\]\[google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path\].

If
\[SearchRequest.EmbeddingSpec.EmbeddingVector.field_path\]\[google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path\]
is not provided, it will use
\[ServingConfig.EmbeddingConfig.field_path\]\[google.cloud.discoveryengine.v1beta.ServingConfig.embedding_config\].

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.EmbeddingSpec` |   |

### Entity

    public string Entity { get; set; }

Optional. The entity for customers that may run multiple different
entities, domains, sites or regions, for example, "Google US", "Google
Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
be exactly matched with
\[UserEvent.entity\]\[google.cloud.discoveryengine.v1beta.UserEvent.entity\] to
get search results boosted by entity.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### FacetSpecs

    public RepeatedField<SearchRequest.Types.FacetSpec> FacetSpecs { get; }

Facet specifications for faceted search. If empty, no facets are returned.

A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT`
error is returned.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.FacetSpec` |   |

### 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.

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 customer 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](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### ImageQuery

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

Raw image query.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.ImageQuery` |   |

### LanguageCode

    public string LanguageCode { get; set; }

The BCP-47 language code, such as "en-US" or "sr-Latn". For more
information, see [Standard
fields](https://cloud.google.com/apis/design/standard_fields). This field
helps to better interpret the query. If a value isn't specified, the query
language code is automatically detected, which may not be accurate.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### NaturalLanguageQueryUnderstandingSpec

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

Optional. Config for natural language query understanding capabilities,
such as extracting structured field filters from the query. Refer to [this
documentation](https://cloud.google.com/generative-ai-app-builder/docs/natural-language-queries)
for more information.
If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional
natural language query understanding will be done.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.NaturalLanguageQueryUnderstandingSpec` |   |

### NumResultsPerDataStore

    public int NumResultsPerDataStore { get; set; }

Optional. The maximum number of results to retrieve from each data store.
If not specified, it will use the
\[SearchRequest.DataStoreSpec.num_results\]\[google.cloud.discoveryengine.v1beta.SearchRequest.DataStoreSpec.num_results\]
if provided, otherwise there is no limit.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int32` |   |

### Offset

    public int Offset { get; set; }

A 0-indexed integer that specifies the current offset (that is, starting
result location, amongst the
\[Document\]\[google.cloud.discoveryengine.v1beta.Document\]s deemed by the API
as relevant) in search results. This field is only considered if
\[page_token\]\[google.cloud.discoveryengine.v1beta.SearchRequest.page_token\]
is unset.

If this field is negative, an `INVALID_ARGUMENT` is returned.

A large offset may be capped to a reasonable threshold.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int32` |   |

### OneBoxPageSize

    public int OneBoxPageSize { get; set; }

The maximum number of results to return for OneBox.
This applies to each OneBox type individually.
Default number is 10.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int32` |   |

### 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.v1beta.Document\]
object. Leave it unset if ordered by relevance. `order_by` expression is
case-sensitive.

For more information on ordering the website search results, see
[Order web search
results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
For more information on ordering the healthcare search results, see
[Order healthcare search
results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### PageCategories

    public RepeatedField<string> PageCategories { get; }

Optional. The categories associated with a category page. Must be set for
category navigation queries to achieve good search quality. The format
should be the same as
\[PageInfo.page_category\]\[google.cloud.discoveryengine.v1beta.PageInfo.page_category\].
This field is the equivalent of the query for browse (navigation) queries.
It's used by the browse model when the query is empty.

If the field is empty, it will not be used by the browse model.
If the field contains more than one element, only the first element will
be used.

To represent full path of a category, use '\>' character to separate
different hierarchies. If '\>' is part of the category name, replace it with
other character(s).
For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX \>
4090" represents one level, can be rewritten as \`Graphics Cards \> RTX_4090
> Founders Edition\`

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### PageSize

    public int PageSize { get; set; }

Maximum number of \[Document\]\[google.cloud.discoveryengine.v1beta.Document\]s
to return. The maximum allowed value depends on the data type. Values above
the maximum value are coerced to the maximum value.

- Websites with basic indexing: Default `10`, Maximum `25`.
- Websites with advanced indexing: Default `25`, Maximum `50`.
- Other: Default `50`, Maximum `100`.

If this field is negative, an `INVALID_ARGUMENT` is returned.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int32` |   |

### PageToken

    public string PageToken { get; set; }

A page token received from a previous
\[SearchService.Search\]\[google.cloud.discoveryengine.v1beta.SearchService.Search\]
call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to
\[SearchService.Search\]\[google.cloud.discoveryengine.v1beta.SearchService.Search\]
must match the call that provided the page token. Otherwise, an
`INVALID_ARGUMENT` error is returned.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Params

    public MapField<string, Value> Params { get; }

Additional search parameters.

For public website search only, supported values are:

- `user_country_code`: string. Default empty. If set to non-empty, results
  are restricted or boosted based on the location provided.
  For example, `user_country_code: "au"`

  For available codes see [Country
  Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
- `search_type`: double. Default empty. Enables non-webpage searching
  depending on the value. The only valid non-default value is 1,
  which enables image searching.
  For example, `search_type: 1`

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.MapField-2.htmlhttps://learn.microsoft.com/dotnet/api/system.stringhttps://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Value.html` |   |

### PersonalizationSpec

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

The specification for personalization.

Notice that if both
\[ServingConfig.personalization_spec\]\[google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec\]
and
\[SearchRequest.personalization_spec\]\[google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec\]
are set,
\[SearchRequest.personalization_spec\]\[google.cloud.discoveryengine.v1beta.SearchRequest.personalization_spec\]
overrides
\[ServingConfig.personalization_spec\]\[google.cloud.discoveryengine.v1beta.ServingConfig.personalization_spec\].

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.PersonalizationSpec` |   |

### Query

    public string Query { get; set; }

Raw search query.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### QueryExpansionSpec

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

The query expansion specification that specifies the conditions under which
query expansion occurs.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.QueryExpansionSpec` |   |

### RankingExpression

    public string RankingExpression { get; set; }

Optional. The ranking expression controls the customized ranking on
retrieval documents. This overrides
\[ServingConfig.ranking_expression\]\[google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression\].
The syntax and supported features depend on the
`ranking_expression_backend` value. If `ranking_expression_backend` is not
provided, it defaults to `RANK_BY_EMBEDDING`.

If
\[ranking_expression_backend\]\[google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend\]
is not provided or set to `RANK_BY_EMBEDDING`, it should be a single
function or multiple functions that are joined by "+".

- ranking_expression = function, { " + ", function };

Supported functions:

- double \* relevance_score
- double \* dotProduct(embedding_field_path)

Function variables:

- `relevance_score`: pre-defined keywords, used for measure relevance between query and document.
- `embedding_field_path`: the document embedding field used with query embedding vector.
- `dotProduct`: embedding function between `embedding_field_path` and
  query embedding vector.

  Example ranking expression:

  If document has an embedding field doc_embedding, the ranking expression
  could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.

If
\[ranking_expression_backend\]\[google.cloud.discoveryengine.v1beta.SearchRequest.ranking_expression_backend\]
is set to `RANK_BY_FORMULA`, the following expression types (and
combinations of those chained using + or

- operators) are supported:

  - `double`
  - `signal`
  - `log(signal)`
  - `exp(signal)`
  - `rr(signal, double > 0)` -- reciprocal rank transformation with second argument being a denominator constant.
  - `is_nan(signal)` -- returns 0 if signal is NaN, 1 otherwise.
  - `fill_nan(signal1, signal2 | double)` -- if signal1 is NaN, returns signal2 \| double, else returns signal1.

  Here are a few examples of ranking formulas that use the supported
  ranking expression types:
  - `0.2 * semantic_similarity_score + 0.8 * log(keyword_similarity_score)` -- mostly rank by the logarithm of `keyword_similarity_score` with slight `semantic_smilarity_score` adjustment.
  - `0.2 * exp(fill_nan(semantic_similarity_score, 0)) + 0.3 *
    is_nan(keyword_similarity_score)` -- rank by the exponent of `semantic_similarity_score` filling the value with 0 if it's NaN, also add constant 0.3 adjustment to the final score if `semantic_similarity_score` is NaN.
  - `0.2 * rr(semantic_similarity_score, 16) + 0.8 *
    rr(keyword_similarity_score, 16)` -- mostly rank by the reciprocal rank of `keyword_similarity_score` with slight adjustment of reciprocal rank of `semantic_smilarity_score`.

The following signals are supported:

- `semantic_similarity_score`: semantic similarity adjustment that is calculated using the embeddings generated by a proprietary Google model. This score determines how semantically similar a search query is to a document.
- `keyword_similarity_score`: keyword match adjustment uses the Best Match 25 (BM25) ranking function. This score is calculated using a probabilistic model to estimate the probability that a document is relevant to a given query.
- `relevance_score`: semantic relevance adjustment that uses a proprietary Google model to determine the meaning and intent behind a user's query in context with the content in the documents.
- `pctr_rank`: predicted conversion rate adjustment as a rank use predicted Click-through rate (pCTR) to gauge the relevance and attractiveness of a search result from a user's perspective. A higher pCTR suggests that the result is more likely to satisfy the user's query and intent, making it a valuable signal for ranking.
- `freshness_rank`: freshness adjustment as a rank
- `document_age`: The time in hours elapsed since the document was last updated, a floating-point number (e.g., 0.25 means 15 minutes).
- `topicality_rank`: topicality adjustment as a rank. Uses proprietary Google model to determine the keyword-based overlap between the query and the document.
- `base_rank`: the default rank of the result
- `media_actor_match`: whether the media actor matches the query
- `media_director_match`: whether the media director matches the query
- `media_genre_match`: whether the media genre matches the query
- `media_language_match`: whether the media language matches the query
- `media_title_match`: whether the media title matches the query
- `media_prefix_similarity_rank`: prefix similarity rank for media results
- `media_semantic_similarity_rank`: semantic similarity rank for media results

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### RankingExpressionBackend

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

Optional. The backend to use for the ranking expression evaluation.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.RankingExpressionBackend` |   |

### RegionCode

    public string RegionCode { get; set; }

The Unicode country/region code (CLDR) of a location, such as "US" and
"419". For more information, see [Standard
fields](https://cloud.google.com/apis/design/standard_fields). If set,
then results will be boosted based on the region_code provided.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### RelevanceFilterSpec

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

Optional. The granular relevance filtering specification.

If not specified, the global `relevance_threshold` will be used for all
sub-searches. If specified, this overrides the global
`relevance_threshold` to use thresholds on a per sub-search basis.

This feature is currently supported only for custom and site search.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.RelevanceFilterSpec` |   |

### RelevanceScoreSpec

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

Optional. The specification for returning the relevance score.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.RelevanceScoreSpec` |   |

### RelevanceThreshold

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

The global relevance threshold of the search results.

Defaults to Google defined threshold, leveraging a balance of
precision and recall to deliver both highly accurate results and
comprehensive coverage of relevant information.

If more granular relevance filtering is required, use the
`relevance_filter_spec` instead.

This feature is not supported for healthcare search.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.RelevanceThreshold` |   |

### SafeSearch

    public bool SafeSearch { get; set; }

Whether to turn on safe search. This is only supported for
website search.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### SearchAddonSpec

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

Optional. SearchAddonSpec is used to disable add-ons for search as per new
repricing model.
This field is only supported for search requests.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.SearchAddonSpec` |   |

### SearchAsYouTypeSpec

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

Search as you type configuration. Only supported for the
\[IndustryVertical.MEDIA\]\[google.cloud.discoveryengine.v1beta.IndustryVertical.MEDIA\]
vertical.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.SearchAsYouTypeSpec` |   |

### ServingConfig

    public string ServingConfig { get; set; }

Required. The resource name of the Search serving config, such as
`projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
or
`projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
This field is used to identify the serving configuration name, set
of models used to make the search.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### ServingConfigAsServingConfigName

    public ServingConfigName ServingConfigAsServingConfigName { get; set; }

[ServingConfigName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ServingConfigName)-typed view over the [ServingConfig](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest#Google_Cloud_DiscoveryEngine_V1Beta_SearchRequest_ServingConfig) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ServingConfigName` |   |

### Session

    public string Session { get; set; }

The session resource name. Optional.

Session allows users to do multi-turn /search API calls or coordination
between /search API calls and /answer API calls.

Example #1 (multi-turn /search API calls):
Call /search API with the session ID generated in the first call.
Here, the previous search query gets considered in query
standing. I.e., if the first query is "How did Alphabet do in 2022?"
and the current query is "How about 2023?", the current query will
be interpreted as "How did Alphabet do in 2023?".

Example #2 (coordination between /search API calls and /answer API calls):
Call /answer API with the session ID generated in the first call.
Here, the answer generation happens in the context of the search
results from the first search call.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### SessionAsSessionName

    public SessionName SessionAsSessionName { get; set; }

[SessionName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SessionName)-typed view over the [Session](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest#Google_Cloud_DiscoveryEngine_V1Beta_SearchRequest_Session) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SessionName` |   |

### SessionSpec

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

Session specification.

Can be used only when `session` is set.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.SessionSpec` |   |

### SpellCorrectionSpec

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

The spell correction specification that specifies the mode under
which spell correction takes effect.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SearchRequest.Types.SpellCorrectionSpec` |   |

### UserInfo

    public UserInfo UserInfo { get; set; }

Information about the end user.
Highly recommended for analytics and personalization.
\[UserInfo.user_agent\]\[google.cloud.discoveryengine.v1beta.UserInfo.user_agent\]
is used to deduce `device_type` for analytics.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.UserInfo` |   |

### UserLabels

    public MapField<string, string> UserLabels { get; }

The user labels applied to a resource must meet the following requirements:

- Each resource can have multiple labels, up to a maximum of 64.
- Each label must be a key-value pair.
- Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
- Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
- The key portion of a label must be unique. However, you can use the same key with multiple resources.
- Keys must start with a lowercase letter or international character.

See [Google Cloud
Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
for more details.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.MapField-2.htmlhttps://learn.microsoft.com/dotnet/api/system.stringhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### UserPseudoId

    public string UserPseudoId { get; set; }

Optional. A unique identifier for tracking visitors. For example, this
could be implemented with an HTTP cookie, which should be able to uniquely
identify a visitor on a single device. This unique identifier should not
change if the visitor logs in or out of the website.

This field should NOT have a fixed value such as `unknown_visitor`.

This should be the same identifier as
\[UserEvent.user_pseudo_id\]\[google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id\]
and
\[CompleteQueryRequest.user_pseudo_id\]\[google.cloud.discoveryengine.v1beta.CompleteQueryRequest.user_pseudo_id\]

The field must be a UTF-8 encoded string with a length limit of 128
characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |