Represents a RankSignals.
Package
@google-cloud/discoveryengineConstructors
(constructor)(properties)
constructor(properties?: google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.IRankSignals);Constructs a new RankSignals.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRankSignals
Properties to set |
Properties
boostingFactor
public boostingFactor?: (number|null);RankSignals boostingFactor.
customSignals
public customSignals: google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals.ICustomSignal[];RankSignals customSignals.
defaultRank
public defaultRank: number;RankSignals defaultRank.
documentAge
public documentAge?: (number|null);RankSignals documentAge.
keywordSimilarityScore
public keywordSimilarityScore?: (number|null);RankSignals keywordSimilarityScore.
pctrRank
public pctrRank?: (number|null);RankSignals pctrRank.
relevanceScore
public relevanceScore?: (number|null);RankSignals relevanceScore.
semanticSimilarityScore
public semanticSimilarityScore?: (number|null);RankSignals semanticSimilarityScore.
topicalityRank
public topicalityRank?: (number|null);RankSignals topicalityRank.
Methods
create(properties)
public static create(properties?: google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.IRankSignals): google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals;Creates a new RankSignals instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRankSignals
Properties to set |
| Returns | |
|---|---|
| Type | Description |
RankSignals |
RankSignals instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals;Decodes a RankSignals message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
RankSignals |
RankSignals |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals;Decodes a RankSignals message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
RankSignals |
RankSignals |
encode(message, writer)
public static encode(message: google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.IRankSignals, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified RankSignals message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRankSignals
RankSignals message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.IRankSignals, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified RankSignals message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRankSignals
RankSignals message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals;Creates a RankSignals message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
RankSignals |
RankSignals |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for RankSignals
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this RankSignals to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a RankSignals message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
RankSignals
RankSignals |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a RankSignals message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|