Class GoogleCloudDiscoveryengineV1RankRequest

Request message for RankService.Rank method.

Inheritance

object

GoogleCloudDiscoveryengineV1RankRequest

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.DiscoveryEngine.v1.Data

Assembly: Google.Apis.DiscoveryEngine.v1.dll

Syntax

public class GoogleCloudDiscoveryengineV1RankRequest : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

IgnoreRecordDetailsInResponse

If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.

Declaration

[JsonProperty("ignoreRecordDetailsInResponse")]
public virtual bool? IgnoreRecordDetailsInResponse { get; set; }

Property Value

Type	Description
bool?

Model

The identifier of the model to use. It is one of: * semantic-ranker-512@latest: Semantic ranking model with maxiumn input token size 512. It is set to semantic-ranker-512@latest by default if unspecified.

Declaration

[JsonProperty("model")]
public virtual string Model { get; set; }

Property Value

Type	Description
string

Query

The query to use.

Declaration

[JsonProperty("query")]
public virtual string Query { get; set; }

Property Value

Type	Description
string

Records

Required. A list of records to rank. At most 200 records to rank.

Declaration

[JsonProperty("records")]
public virtual IList<GoogleCloudDiscoveryengineV1RankingRecord> Records { get; set; }

Property Value

Type	Description
IList<GoogleCloudDiscoveryengineV1RankingRecord>

TopN

The number of results to return. If this is unset or no bigger than zero, returns all results.

Declaration

[JsonProperty("topN")]
public virtual int? TopN { get; set; }

Property Value

Type	Description
int?

UserLabels

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 for more details.

Declaration

[JsonProperty("userLabels")]
public virtual IDictionary<string, string> UserLabels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

Implements

IDirectResponseSchema