1.0.0-beta25 (latest) 1.0.0-beta24

    public sealed class RecommendRequest : IMessage<RecommendRequest>, IEquatable<RecommendRequest>, IDeepCloneable<RecommendRequest>, IBufferMessage, IMessage

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

Request message for Recommend method.

## Inheritance

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

## Implements

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

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

### RecommendRequest()

    public RecommendRequest()

### RecommendRequest(RecommendRequest)

    public RecommendRequest(RecommendRequest other)

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

## Properties

### Filter

    public string Filter { get; set; }

Filter for restricting recommendation results with a length limit of 5,000
characters. Currently, only filter expressions on the `filter_tags`
attribute is supported.

Examples:

- `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
- `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`

If `attributeFilteringSyntax` is set to true under the `params` field, then
attribute-based expressions are expected instead of the above described
tag-based syntax. Examples:

- (language: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
- (available: true) AND (language: ANY("en", "es")) OR (categories: ANY("Movie"))

If your filter blocks all results, the API returns generic
(unfiltered) popular Documents. If you only want results strictly matching
the filters, set `strictFiltering` to `true` in
\[RecommendRequest.params\]\[google.cloud.discoveryengine.v1beta.RecommendRequest.params\]
to receive empty results instead.

Note that the API never returns
\[Document\]\[google.cloud.discoveryengine.v1beta.Document\]s with
`storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.

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

### PageSize

    public int PageSize { get; set; }

Maximum number of results to return. Set this property
to the number of recommendation results needed. If zero, the service
chooses a reasonable default. The maximum allowed value is 100. Values
above 100 are set to 100.

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

### Params

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

Additional domain specific parameters for the recommendations.

Allowed values:

- `returnDocument`: Boolean. If set to `true`, the associated Document object is returned in \[RecommendResponse.RecommendationResult.document\]\[google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document\].
- `returnScore`: Boolean. If set to true, the recommendation score corresponding to each returned Document is set in \[RecommendResponse.RecommendationResult.metadata\]\[google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata\]. The given score indicates the probability of a Document conversion given the user's context and history.
- `strictFiltering`: Boolean. True by default. If set to `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results.
- `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of:
  - `no-diversity`
  - `low-diversity`
  - `medium-diversity`
  - `high-diversity`
  - `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category.
- `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.

| **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` |   |

### ServingConfig

    public string ServingConfig { get; set; }

Required. Full resource name of a
\[ServingConfig\]\[google.cloud.discoveryengine.v1beta.ServingConfig\]:
`projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
`projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`

One default serving config is created along with your recommendation engine
creation. The engine ID is used as the ID of the default serving
config. For example, for Engine
`projects/*/locations/global/collections/*/engines/my-engine`, you can use
`projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
for your
\[RecommendationService.Recommend\]\[google.cloud.discoveryengine.v1beta.RecommendationService.Recommend\]
requests.

| **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.RecommendRequest#Google_Cloud_DiscoveryEngine_V1Beta_RecommendRequest_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` |   |

### UserEvent

    public UserEvent UserEvent { get; set; }

Required. Context about the user, what they are looking at and what action
they took to trigger the Recommend request. Note that this user event
detail won't be ingested to userEvent logs. Thus, a separate userEvent
write request is required for event logging.

Don't set
\[UserEvent.user_pseudo_id\]\[google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id\]
or
\[UserEvent.user_info.user_id\]\[google.cloud.discoveryengine.v1beta.UserInfo.user_id\]
to the same fixed ID for different users. If you are trying to receive
non-personalized recommendations (not recommended; this can negatively
impact model performance), instead set
\[UserEvent.user_pseudo_id\]\[google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id\]
to a random unique ID and leave
\[UserEvent.user_info.user_id\]\[google.cloud.discoveryengine.v1beta.UserInfo.user_id\]
unset.

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

### 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 [Requirements for
labels](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` |   |

### ValidateOnly

    public bool ValidateOnly { get; set; }

Use validate only mode for this recommendation query. If set to `true`, a
fake model is used that returns arbitrary Document IDs.
Note that the validate only mode should only be used for testing the API,
or if the model is not ready.

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