@google-cloud/discoveryengine 2.4.0 → 2.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5089,6 +5089,12 @@ export namespace google {
5089
5089
 
5090
5090
  /** SearchRequest relevanceScoreSpec */
5091
5091
  relevanceScoreSpec?: (google.cloud.discoveryengine.v1.SearchRequest.IRelevanceScoreSpec|null);
5092
+
5093
+ /** SearchRequest rankingExpression */
5094
+ rankingExpression?: (string|null);
5095
+
5096
+ /** SearchRequest rankingExpressionBackend */
5097
+ rankingExpressionBackend?: (google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend|keyof typeof google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend|null);
5092
5098
  }
5093
5099
 
5094
5100
  /** Represents a SearchRequest. */
@@ -5187,6 +5193,12 @@ export namespace google {
5187
5193
  /** SearchRequest relevanceScoreSpec. */
5188
5194
  public relevanceScoreSpec?: (google.cloud.discoveryengine.v1.SearchRequest.IRelevanceScoreSpec|null);
5189
5195
 
5196
+ /** SearchRequest rankingExpression. */
5197
+ public rankingExpression: string;
5198
+
5199
+ /** SearchRequest rankingExpressionBackend. */
5200
+ public rankingExpressionBackend: (google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend|keyof typeof google.cloud.discoveryengine.v1.SearchRequest.RankingExpressionBackend);
5201
+
5190
5202
  /**
5191
5203
  * Creates a new SearchRequest instance using the specified properties.
5192
5204
  * @param [properties] Properties to set
@@ -7634,6 +7646,13 @@ export namespace google {
7634
7646
  MEDIUM = 3,
7635
7647
  HIGH = 4
7636
7648
  }
7649
+
7650
+ /** RankingExpressionBackend enum. */
7651
+ enum RankingExpressionBackend {
7652
+ RANKING_EXPRESSION_BACKEND_UNSPECIFIED = 0,
7653
+ RANK_BY_EMBEDDING = 3,
7654
+ RANK_BY_FORMULA = 4
7655
+ }
7637
7656
  }
7638
7657
 
7639
7658
  /** Properties of a SearchResponse. */
@@ -7809,6 +7828,9 @@ export namespace google {
7809
7828
 
7810
7829
  /** SearchResult modelScores */
7811
7830
  modelScores?: ({ [k: string]: google.cloud.discoveryengine.v1.IDoubleList }|null);
7831
+
7832
+ /** SearchResult rankSignals */
7833
+ rankSignals?: (google.cloud.discoveryengine.v1.SearchResponse.SearchResult.IRankSignals|null);
7812
7834
  }
7813
7835
 
7814
7836
  /** Represents a SearchResult. */
@@ -7832,6 +7854,9 @@ export namespace google {
7832
7854
  /** SearchResult modelScores. */
7833
7855
  public modelScores: { [k: string]: google.cloud.discoveryengine.v1.IDoubleList };
7834
7856
 
7857
+ /** SearchResult rankSignals. */
7858
+ public rankSignals?: (google.cloud.discoveryengine.v1.SearchResponse.SearchResult.IRankSignals|null);
7859
+
7835
7860
  /**
7836
7861
  * Creates a new SearchResult instance using the specified properties.
7837
7862
  * @param [properties] Properties to set
@@ -7910,6 +7935,260 @@ export namespace google {
7910
7935
  public static getTypeUrl(typeUrlPrefix?: string): string;
7911
7936
  }
7912
7937
 
7938
+ namespace SearchResult {
7939
+
7940
+ /** Properties of a RankSignals. */
7941
+ interface IRankSignals {
7942
+
7943
+ /** RankSignals keywordSimilarityScore */
7944
+ keywordSimilarityScore?: (number|null);
7945
+
7946
+ /** RankSignals relevanceScore */
7947
+ relevanceScore?: (number|null);
7948
+
7949
+ /** RankSignals semanticSimilarityScore */
7950
+ semanticSimilarityScore?: (number|null);
7951
+
7952
+ /** RankSignals pctrRank */
7953
+ pctrRank?: (number|null);
7954
+
7955
+ /** RankSignals topicalityRank */
7956
+ topicalityRank?: (number|null);
7957
+
7958
+ /** RankSignals documentAge */
7959
+ documentAge?: (number|null);
7960
+
7961
+ /** RankSignals boostingFactor */
7962
+ boostingFactor?: (number|null);
7963
+
7964
+ /** RankSignals defaultRank */
7965
+ defaultRank?: (number|null);
7966
+
7967
+ /** RankSignals customSignals */
7968
+ customSignals?: (google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.ICustomSignal[]|null);
7969
+ }
7970
+
7971
+ /** Represents a RankSignals. */
7972
+ class RankSignals implements IRankSignals {
7973
+
7974
+ /**
7975
+ * Constructs a new RankSignals.
7976
+ * @param [properties] Properties to set
7977
+ */
7978
+ constructor(properties?: google.cloud.discoveryengine.v1.SearchResponse.SearchResult.IRankSignals);
7979
+
7980
+ /** RankSignals keywordSimilarityScore. */
7981
+ public keywordSimilarityScore?: (number|null);
7982
+
7983
+ /** RankSignals relevanceScore. */
7984
+ public relevanceScore?: (number|null);
7985
+
7986
+ /** RankSignals semanticSimilarityScore. */
7987
+ public semanticSimilarityScore?: (number|null);
7988
+
7989
+ /** RankSignals pctrRank. */
7990
+ public pctrRank?: (number|null);
7991
+
7992
+ /** RankSignals topicalityRank. */
7993
+ public topicalityRank?: (number|null);
7994
+
7995
+ /** RankSignals documentAge. */
7996
+ public documentAge?: (number|null);
7997
+
7998
+ /** RankSignals boostingFactor. */
7999
+ public boostingFactor?: (number|null);
8000
+
8001
+ /** RankSignals defaultRank. */
8002
+ public defaultRank: number;
8003
+
8004
+ /** RankSignals customSignals. */
8005
+ public customSignals: google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.ICustomSignal[];
8006
+
8007
+ /**
8008
+ * Creates a new RankSignals instance using the specified properties.
8009
+ * @param [properties] Properties to set
8010
+ * @returns RankSignals instance
8011
+ */
8012
+ public static create(properties?: google.cloud.discoveryengine.v1.SearchResponse.SearchResult.IRankSignals): google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals;
8013
+
8014
+ /**
8015
+ * Encodes the specified RankSignals message. Does not implicitly {@link google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.verify|verify} messages.
8016
+ * @param message RankSignals message or plain object to encode
8017
+ * @param [writer] Writer to encode to
8018
+ * @returns Writer
8019
+ */
8020
+ public static encode(message: google.cloud.discoveryengine.v1.SearchResponse.SearchResult.IRankSignals, writer?: $protobuf.Writer): $protobuf.Writer;
8021
+
8022
+ /**
8023
+ * Encodes the specified RankSignals message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.verify|verify} messages.
8024
+ * @param message RankSignals message or plain object to encode
8025
+ * @param [writer] Writer to encode to
8026
+ * @returns Writer
8027
+ */
8028
+ public static encodeDelimited(message: google.cloud.discoveryengine.v1.SearchResponse.SearchResult.IRankSignals, writer?: $protobuf.Writer): $protobuf.Writer;
8029
+
8030
+ /**
8031
+ * Decodes a RankSignals message from the specified reader or buffer.
8032
+ * @param reader Reader or buffer to decode from
8033
+ * @param [length] Message length if known beforehand
8034
+ * @returns RankSignals
8035
+ * @throws {Error} If the payload is not a reader or valid buffer
8036
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
8037
+ */
8038
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals;
8039
+
8040
+ /**
8041
+ * Decodes a RankSignals message from the specified reader or buffer, length delimited.
8042
+ * @param reader Reader or buffer to decode from
8043
+ * @returns RankSignals
8044
+ * @throws {Error} If the payload is not a reader or valid buffer
8045
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
8046
+ */
8047
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals;
8048
+
8049
+ /**
8050
+ * Verifies a RankSignals message.
8051
+ * @param message Plain object to verify
8052
+ * @returns `null` if valid, otherwise the reason why it is not
8053
+ */
8054
+ public static verify(message: { [k: string]: any }): (string|null);
8055
+
8056
+ /**
8057
+ * Creates a RankSignals message from a plain object. Also converts values to their respective internal types.
8058
+ * @param object Plain object
8059
+ * @returns RankSignals
8060
+ */
8061
+ public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals;
8062
+
8063
+ /**
8064
+ * Creates a plain object from a RankSignals message. Also converts values to other types if specified.
8065
+ * @param message RankSignals
8066
+ * @param [options] Conversion options
8067
+ * @returns Plain object
8068
+ */
8069
+ public static toObject(message: google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals, options?: $protobuf.IConversionOptions): { [k: string]: any };
8070
+
8071
+ /**
8072
+ * Converts this RankSignals to JSON.
8073
+ * @returns JSON object
8074
+ */
8075
+ public toJSON(): { [k: string]: any };
8076
+
8077
+ /**
8078
+ * Gets the default type url for RankSignals
8079
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
8080
+ * @returns The default type url
8081
+ */
8082
+ public static getTypeUrl(typeUrlPrefix?: string): string;
8083
+ }
8084
+
8085
+ namespace RankSignals {
8086
+
8087
+ /** Properties of a CustomSignal. */
8088
+ interface ICustomSignal {
8089
+
8090
+ /** CustomSignal name */
8091
+ name?: (string|null);
8092
+
8093
+ /** CustomSignal value */
8094
+ value?: (number|null);
8095
+ }
8096
+
8097
+ /** Represents a CustomSignal. */
8098
+ class CustomSignal implements ICustomSignal {
8099
+
8100
+ /**
8101
+ * Constructs a new CustomSignal.
8102
+ * @param [properties] Properties to set
8103
+ */
8104
+ constructor(properties?: google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.ICustomSignal);
8105
+
8106
+ /** CustomSignal name. */
8107
+ public name: string;
8108
+
8109
+ /** CustomSignal value. */
8110
+ public value: number;
8111
+
8112
+ /**
8113
+ * Creates a new CustomSignal instance using the specified properties.
8114
+ * @param [properties] Properties to set
8115
+ * @returns CustomSignal instance
8116
+ */
8117
+ public static create(properties?: google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.ICustomSignal): google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal;
8118
+
8119
+ /**
8120
+ * Encodes the specified CustomSignal message. Does not implicitly {@link google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal.verify|verify} messages.
8121
+ * @param message CustomSignal message or plain object to encode
8122
+ * @param [writer] Writer to encode to
8123
+ * @returns Writer
8124
+ */
8125
+ public static encode(message: google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.ICustomSignal, writer?: $protobuf.Writer): $protobuf.Writer;
8126
+
8127
+ /**
8128
+ * Encodes the specified CustomSignal message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal.verify|verify} messages.
8129
+ * @param message CustomSignal message or plain object to encode
8130
+ * @param [writer] Writer to encode to
8131
+ * @returns Writer
8132
+ */
8133
+ public static encodeDelimited(message: google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.ICustomSignal, writer?: $protobuf.Writer): $protobuf.Writer;
8134
+
8135
+ /**
8136
+ * Decodes a CustomSignal message from the specified reader or buffer.
8137
+ * @param reader Reader or buffer to decode from
8138
+ * @param [length] Message length if known beforehand
8139
+ * @returns CustomSignal
8140
+ * @throws {Error} If the payload is not a reader or valid buffer
8141
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
8142
+ */
8143
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal;
8144
+
8145
+ /**
8146
+ * Decodes a CustomSignal message from the specified reader or buffer, length delimited.
8147
+ * @param reader Reader or buffer to decode from
8148
+ * @returns CustomSignal
8149
+ * @throws {Error} If the payload is not a reader or valid buffer
8150
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
8151
+ */
8152
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal;
8153
+
8154
+ /**
8155
+ * Verifies a CustomSignal message.
8156
+ * @param message Plain object to verify
8157
+ * @returns `null` if valid, otherwise the reason why it is not
8158
+ */
8159
+ public static verify(message: { [k: string]: any }): (string|null);
8160
+
8161
+ /**
8162
+ * Creates a CustomSignal message from a plain object. Also converts values to their respective internal types.
8163
+ * @param object Plain object
8164
+ * @returns CustomSignal
8165
+ */
8166
+ public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal;
8167
+
8168
+ /**
8169
+ * Creates a plain object from a CustomSignal message. Also converts values to other types if specified.
8170
+ * @param message CustomSignal
8171
+ * @param [options] Conversion options
8172
+ * @returns Plain object
8173
+ */
8174
+ public static toObject(message: google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal, options?: $protobuf.IConversionOptions): { [k: string]: any };
8175
+
8176
+ /**
8177
+ * Converts this CustomSignal to JSON.
8178
+ * @returns JSON object
8179
+ */
8180
+ public toJSON(): { [k: string]: any };
8181
+
8182
+ /**
8183
+ * Gets the default type url for CustomSignal
8184
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
8185
+ * @returns The default type url
8186
+ */
8187
+ public static getTypeUrl(typeUrlPrefix?: string): string;
8188
+ }
8189
+ }
8190
+ }
8191
+
7913
8192
  /** Properties of a Facet. */
7914
8193
  interface IFacet {
7915
8194
 
@@ -62886,6 +63165,9 @@ export namespace google {
62886
63165
  /** SearchRequest rankingExpression */
62887
63166
  rankingExpression?: (string|null);
62888
63167
 
63168
+ /** SearchRequest rankingExpressionBackend */
63169
+ rankingExpressionBackend?: (google.cloud.discoveryengine.v1alpha.SearchRequest.RankingExpressionBackend|keyof typeof google.cloud.discoveryengine.v1alpha.SearchRequest.RankingExpressionBackend|null);
63170
+
62889
63171
  /** SearchRequest safeSearch */
62890
63172
  safeSearch?: (boolean|null);
62891
63173
 
@@ -62989,6 +63271,9 @@ export namespace google {
62989
63271
  /** SearchRequest rankingExpression. */
62990
63272
  public rankingExpression: string;
62991
63273
 
63274
+ /** SearchRequest rankingExpressionBackend. */
63275
+ public rankingExpressionBackend: (google.cloud.discoveryengine.v1alpha.SearchRequest.RankingExpressionBackend|keyof typeof google.cloud.discoveryengine.v1alpha.SearchRequest.RankingExpressionBackend);
63276
+
62992
63277
  /** SearchRequest safeSearch. */
62993
63278
  public safeSearch: boolean;
62994
63279
 
@@ -65547,6 +65832,13 @@ export namespace google {
65547
65832
  MEDIUM = 3,
65548
65833
  HIGH = 4
65549
65834
  }
65835
+
65836
+ /** RankingExpressionBackend enum. */
65837
+ enum RankingExpressionBackend {
65838
+ RANKING_EXPRESSION_BACKEND_UNSPECIFIED = 0,
65839
+ RANK_BY_EMBEDDING = 3,
65840
+ RANK_BY_FORMULA = 4
65841
+ }
65550
65842
  }
65551
65843
 
65552
65844
  /** Properties of a SearchResponse. */
@@ -65746,6 +66038,9 @@ export namespace google {
65746
66038
 
65747
66039
  /** SearchResult modelScores */
65748
66040
  modelScores?: ({ [k: string]: google.cloud.discoveryengine.v1alpha.IDoubleList }|null);
66041
+
66042
+ /** SearchResult rankSignals */
66043
+ rankSignals?: (google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.IRankSignals|null);
65749
66044
  }
65750
66045
 
65751
66046
  /** Represents a SearchResult. */
@@ -65769,6 +66064,9 @@ export namespace google {
65769
66064
  /** SearchResult modelScores. */
65770
66065
  public modelScores: { [k: string]: google.cloud.discoveryengine.v1alpha.IDoubleList };
65771
66066
 
66067
+ /** SearchResult rankSignals. */
66068
+ public rankSignals?: (google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.IRankSignals|null);
66069
+
65772
66070
  /**
65773
66071
  * Creates a new SearchResult instance using the specified properties.
65774
66072
  * @param [properties] Properties to set
@@ -65847,6 +66145,260 @@ export namespace google {
65847
66145
  public static getTypeUrl(typeUrlPrefix?: string): string;
65848
66146
  }
65849
66147
 
66148
+ namespace SearchResult {
66149
+
66150
+ /** Properties of a RankSignals. */
66151
+ interface IRankSignals {
66152
+
66153
+ /** RankSignals keywordSimilarityScore */
66154
+ keywordSimilarityScore?: (number|null);
66155
+
66156
+ /** RankSignals relevanceScore */
66157
+ relevanceScore?: (number|null);
66158
+
66159
+ /** RankSignals semanticSimilarityScore */
66160
+ semanticSimilarityScore?: (number|null);
66161
+
66162
+ /** RankSignals pctrRank */
66163
+ pctrRank?: (number|null);
66164
+
66165
+ /** RankSignals topicalityRank */
66166
+ topicalityRank?: (number|null);
66167
+
66168
+ /** RankSignals documentAge */
66169
+ documentAge?: (number|null);
66170
+
66171
+ /** RankSignals boostingFactor */
66172
+ boostingFactor?: (number|null);
66173
+
66174
+ /** RankSignals defaultRank */
66175
+ defaultRank?: (number|null);
66176
+
66177
+ /** RankSignals customSignals */
66178
+ customSignals?: (google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals.ICustomSignal[]|null);
66179
+ }
66180
+
66181
+ /** Represents a RankSignals. */
66182
+ class RankSignals implements IRankSignals {
66183
+
66184
+ /**
66185
+ * Constructs a new RankSignals.
66186
+ * @param [properties] Properties to set
66187
+ */
66188
+ constructor(properties?: google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.IRankSignals);
66189
+
66190
+ /** RankSignals keywordSimilarityScore. */
66191
+ public keywordSimilarityScore?: (number|null);
66192
+
66193
+ /** RankSignals relevanceScore. */
66194
+ public relevanceScore?: (number|null);
66195
+
66196
+ /** RankSignals semanticSimilarityScore. */
66197
+ public semanticSimilarityScore?: (number|null);
66198
+
66199
+ /** RankSignals pctrRank. */
66200
+ public pctrRank?: (number|null);
66201
+
66202
+ /** RankSignals topicalityRank. */
66203
+ public topicalityRank?: (number|null);
66204
+
66205
+ /** RankSignals documentAge. */
66206
+ public documentAge?: (number|null);
66207
+
66208
+ /** RankSignals boostingFactor. */
66209
+ public boostingFactor?: (number|null);
66210
+
66211
+ /** RankSignals defaultRank. */
66212
+ public defaultRank: number;
66213
+
66214
+ /** RankSignals customSignals. */
66215
+ public customSignals: google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals.ICustomSignal[];
66216
+
66217
+ /**
66218
+ * Creates a new RankSignals instance using the specified properties.
66219
+ * @param [properties] Properties to set
66220
+ * @returns RankSignals instance
66221
+ */
66222
+ public static create(properties?: google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.IRankSignals): google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals;
66223
+
66224
+ /**
66225
+ * Encodes the specified RankSignals message. Does not implicitly {@link google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals.verify|verify} messages.
66226
+ * @param message RankSignals message or plain object to encode
66227
+ * @param [writer] Writer to encode to
66228
+ * @returns Writer
66229
+ */
66230
+ public static encode(message: google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.IRankSignals, writer?: $protobuf.Writer): $protobuf.Writer;
66231
+
66232
+ /**
66233
+ * Encodes the specified RankSignals message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals.verify|verify} messages.
66234
+ * @param message RankSignals message or plain object to encode
66235
+ * @param [writer] Writer to encode to
66236
+ * @returns Writer
66237
+ */
66238
+ public static encodeDelimited(message: google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.IRankSignals, writer?: $protobuf.Writer): $protobuf.Writer;
66239
+
66240
+ /**
66241
+ * Decodes a RankSignals message from the specified reader or buffer.
66242
+ * @param reader Reader or buffer to decode from
66243
+ * @param [length] Message length if known beforehand
66244
+ * @returns RankSignals
66245
+ * @throws {Error} If the payload is not a reader or valid buffer
66246
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
66247
+ */
66248
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals;
66249
+
66250
+ /**
66251
+ * Decodes a RankSignals message from the specified reader or buffer, length delimited.
66252
+ * @param reader Reader or buffer to decode from
66253
+ * @returns RankSignals
66254
+ * @throws {Error} If the payload is not a reader or valid buffer
66255
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
66256
+ */
66257
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals;
66258
+
66259
+ /**
66260
+ * Verifies a RankSignals message.
66261
+ * @param message Plain object to verify
66262
+ * @returns `null` if valid, otherwise the reason why it is not
66263
+ */
66264
+ public static verify(message: { [k: string]: any }): (string|null);
66265
+
66266
+ /**
66267
+ * Creates a RankSignals message from a plain object. Also converts values to their respective internal types.
66268
+ * @param object Plain object
66269
+ * @returns RankSignals
66270
+ */
66271
+ public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals;
66272
+
66273
+ /**
66274
+ * Creates a plain object from a RankSignals message. Also converts values to other types if specified.
66275
+ * @param message RankSignals
66276
+ * @param [options] Conversion options
66277
+ * @returns Plain object
66278
+ */
66279
+ public static toObject(message: google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals, options?: $protobuf.IConversionOptions): { [k: string]: any };
66280
+
66281
+ /**
66282
+ * Converts this RankSignals to JSON.
66283
+ * @returns JSON object
66284
+ */
66285
+ public toJSON(): { [k: string]: any };
66286
+
66287
+ /**
66288
+ * Gets the default type url for RankSignals
66289
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
66290
+ * @returns The default type url
66291
+ */
66292
+ public static getTypeUrl(typeUrlPrefix?: string): string;
66293
+ }
66294
+
66295
+ namespace RankSignals {
66296
+
66297
+ /** Properties of a CustomSignal. */
66298
+ interface ICustomSignal {
66299
+
66300
+ /** CustomSignal name */
66301
+ name?: (string|null);
66302
+
66303
+ /** CustomSignal value */
66304
+ value?: (number|null);
66305
+ }
66306
+
66307
+ /** Represents a CustomSignal. */
66308
+ class CustomSignal implements ICustomSignal {
66309
+
66310
+ /**
66311
+ * Constructs a new CustomSignal.
66312
+ * @param [properties] Properties to set
66313
+ */
66314
+ constructor(properties?: google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals.ICustomSignal);
66315
+
66316
+ /** CustomSignal name. */
66317
+ public name: string;
66318
+
66319
+ /** CustomSignal value. */
66320
+ public value: number;
66321
+
66322
+ /**
66323
+ * Creates a new CustomSignal instance using the specified properties.
66324
+ * @param [properties] Properties to set
66325
+ * @returns CustomSignal instance
66326
+ */
66327
+ public static create(properties?: google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals.ICustomSignal): google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals.CustomSignal;
66328
+
66329
+ /**
66330
+ * Encodes the specified CustomSignal message. Does not implicitly {@link google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals.CustomSignal.verify|verify} messages.
66331
+ * @param message CustomSignal message or plain object to encode
66332
+ * @param [writer] Writer to encode to
66333
+ * @returns Writer
66334
+ */
66335
+ public static encode(message: google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals.ICustomSignal, writer?: $protobuf.Writer): $protobuf.Writer;
66336
+
66337
+ /**
66338
+ * Encodes the specified CustomSignal message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals.CustomSignal.verify|verify} messages.
66339
+ * @param message CustomSignal message or plain object to encode
66340
+ * @param [writer] Writer to encode to
66341
+ * @returns Writer
66342
+ */
66343
+ public static encodeDelimited(message: google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals.ICustomSignal, writer?: $protobuf.Writer): $protobuf.Writer;
66344
+
66345
+ /**
66346
+ * Decodes a CustomSignal message from the specified reader or buffer.
66347
+ * @param reader Reader or buffer to decode from
66348
+ * @param [length] Message length if known beforehand
66349
+ * @returns CustomSignal
66350
+ * @throws {Error} If the payload is not a reader or valid buffer
66351
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
66352
+ */
66353
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals.CustomSignal;
66354
+
66355
+ /**
66356
+ * Decodes a CustomSignal message from the specified reader or buffer, length delimited.
66357
+ * @param reader Reader or buffer to decode from
66358
+ * @returns CustomSignal
66359
+ * @throws {Error} If the payload is not a reader or valid buffer
66360
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
66361
+ */
66362
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals.CustomSignal;
66363
+
66364
+ /**
66365
+ * Verifies a CustomSignal message.
66366
+ * @param message Plain object to verify
66367
+ * @returns `null` if valid, otherwise the reason why it is not
66368
+ */
66369
+ public static verify(message: { [k: string]: any }): (string|null);
66370
+
66371
+ /**
66372
+ * Creates a CustomSignal message from a plain object. Also converts values to their respective internal types.
66373
+ * @param object Plain object
66374
+ * @returns CustomSignal
66375
+ */
66376
+ public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals.CustomSignal;
66377
+
66378
+ /**
66379
+ * Creates a plain object from a CustomSignal message. Also converts values to other types if specified.
66380
+ * @param message CustomSignal
66381
+ * @param [options] Conversion options
66382
+ * @returns Plain object
66383
+ */
66384
+ public static toObject(message: google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult.RankSignals.CustomSignal, options?: $protobuf.IConversionOptions): { [k: string]: any };
66385
+
66386
+ /**
66387
+ * Converts this CustomSignal to JSON.
66388
+ * @returns JSON object
66389
+ */
66390
+ public toJSON(): { [k: string]: any };
66391
+
66392
+ /**
66393
+ * Gets the default type url for CustomSignal
66394
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
66395
+ * @returns The default type url
66396
+ */
66397
+ public static getTypeUrl(typeUrlPrefix?: string): string;
66398
+ }
66399
+ }
66400
+ }
66401
+
65850
66402
  /** Properties of a Facet. */
65851
66403
  interface IFacet {
65852
66404
 
@@ -108597,6 +109149,9 @@ export namespace google {
108597
109149
  /** SearchRequest rankingExpression */
108598
109150
  rankingExpression?: (string|null);
108599
109151
 
109152
+ /** SearchRequest rankingExpressionBackend */
109153
+ rankingExpressionBackend?: (google.cloud.discoveryengine.v1beta.SearchRequest.RankingExpressionBackend|keyof typeof google.cloud.discoveryengine.v1beta.SearchRequest.RankingExpressionBackend|null);
109154
+
108600
109155
  /** SearchRequest safeSearch */
108601
109156
  safeSearch?: (boolean|null);
108602
109157
 
@@ -108703,6 +109258,9 @@ export namespace google {
108703
109258
  /** SearchRequest rankingExpression. */
108704
109259
  public rankingExpression: string;
108705
109260
 
109261
+ /** SearchRequest rankingExpressionBackend. */
109262
+ public rankingExpressionBackend: (google.cloud.discoveryengine.v1beta.SearchRequest.RankingExpressionBackend|keyof typeof google.cloud.discoveryengine.v1beta.SearchRequest.RankingExpressionBackend);
109263
+
108706
109264
  /** SearchRequest safeSearch. */
108707
109265
  public safeSearch: boolean;
108708
109266
 
@@ -111380,6 +111938,13 @@ export namespace google {
111380
111938
  MEDIUM = 3,
111381
111939
  HIGH = 4
111382
111940
  }
111941
+
111942
+ /** RankingExpressionBackend enum. */
111943
+ enum RankingExpressionBackend {
111944
+ RANKING_EXPRESSION_BACKEND_UNSPECIFIED = 0,
111945
+ RANK_BY_EMBEDDING = 3,
111946
+ RANK_BY_FORMULA = 4
111947
+ }
111383
111948
  }
111384
111949
 
111385
111950
  /** Properties of a SearchResponse. */
@@ -111579,6 +112144,9 @@ export namespace google {
111579
112144
 
111580
112145
  /** SearchResult modelScores */
111581
112146
  modelScores?: ({ [k: string]: google.cloud.discoveryengine.v1beta.IDoubleList }|null);
112147
+
112148
+ /** SearchResult rankSignals */
112149
+ rankSignals?: (google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.IRankSignals|null);
111582
112150
  }
111583
112151
 
111584
112152
  /** Represents a SearchResult. */
@@ -111602,6 +112170,9 @@ export namespace google {
111602
112170
  /** SearchResult modelScores. */
111603
112171
  public modelScores: { [k: string]: google.cloud.discoveryengine.v1beta.IDoubleList };
111604
112172
 
112173
+ /** SearchResult rankSignals. */
112174
+ public rankSignals?: (google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.IRankSignals|null);
112175
+
111605
112176
  /**
111606
112177
  * Creates a new SearchResult instance using the specified properties.
111607
112178
  * @param [properties] Properties to set
@@ -111680,6 +112251,260 @@ export namespace google {
111680
112251
  public static getTypeUrl(typeUrlPrefix?: string): string;
111681
112252
  }
111682
112253
 
112254
+ namespace SearchResult {
112255
+
112256
+ /** Properties of a RankSignals. */
112257
+ interface IRankSignals {
112258
+
112259
+ /** RankSignals keywordSimilarityScore */
112260
+ keywordSimilarityScore?: (number|null);
112261
+
112262
+ /** RankSignals relevanceScore */
112263
+ relevanceScore?: (number|null);
112264
+
112265
+ /** RankSignals semanticSimilarityScore */
112266
+ semanticSimilarityScore?: (number|null);
112267
+
112268
+ /** RankSignals pctrRank */
112269
+ pctrRank?: (number|null);
112270
+
112271
+ /** RankSignals topicalityRank */
112272
+ topicalityRank?: (number|null);
112273
+
112274
+ /** RankSignals documentAge */
112275
+ documentAge?: (number|null);
112276
+
112277
+ /** RankSignals boostingFactor */
112278
+ boostingFactor?: (number|null);
112279
+
112280
+ /** RankSignals defaultRank */
112281
+ defaultRank?: (number|null);
112282
+
112283
+ /** RankSignals customSignals */
112284
+ customSignals?: (google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.ICustomSignal[]|null);
112285
+ }
112286
+
112287
+ /** Represents a RankSignals. */
112288
+ class RankSignals implements IRankSignals {
112289
+
112290
+ /**
112291
+ * Constructs a new RankSignals.
112292
+ * @param [properties] Properties to set
112293
+ */
112294
+ constructor(properties?: google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.IRankSignals);
112295
+
112296
+ /** RankSignals keywordSimilarityScore. */
112297
+ public keywordSimilarityScore?: (number|null);
112298
+
112299
+ /** RankSignals relevanceScore. */
112300
+ public relevanceScore?: (number|null);
112301
+
112302
+ /** RankSignals semanticSimilarityScore. */
112303
+ public semanticSimilarityScore?: (number|null);
112304
+
112305
+ /** RankSignals pctrRank. */
112306
+ public pctrRank?: (number|null);
112307
+
112308
+ /** RankSignals topicalityRank. */
112309
+ public topicalityRank?: (number|null);
112310
+
112311
+ /** RankSignals documentAge. */
112312
+ public documentAge?: (number|null);
112313
+
112314
+ /** RankSignals boostingFactor. */
112315
+ public boostingFactor?: (number|null);
112316
+
112317
+ /** RankSignals defaultRank. */
112318
+ public defaultRank: number;
112319
+
112320
+ /** RankSignals customSignals. */
112321
+ public customSignals: google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.ICustomSignal[];
112322
+
112323
+ /**
112324
+ * Creates a new RankSignals instance using the specified properties.
112325
+ * @param [properties] Properties to set
112326
+ * @returns RankSignals instance
112327
+ */
112328
+ public static create(properties?: google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.IRankSignals): google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals;
112329
+
112330
+ /**
112331
+ * Encodes the specified RankSignals message. Does not implicitly {@link google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.verify|verify} messages.
112332
+ * @param message RankSignals message or plain object to encode
112333
+ * @param [writer] Writer to encode to
112334
+ * @returns Writer
112335
+ */
112336
+ public static encode(message: google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.IRankSignals, writer?: $protobuf.Writer): $protobuf.Writer;
112337
+
112338
+ /**
112339
+ * Encodes the specified RankSignals message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.verify|verify} messages.
112340
+ * @param message RankSignals message or plain object to encode
112341
+ * @param [writer] Writer to encode to
112342
+ * @returns Writer
112343
+ */
112344
+ public static encodeDelimited(message: google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.IRankSignals, writer?: $protobuf.Writer): $protobuf.Writer;
112345
+
112346
+ /**
112347
+ * Decodes a RankSignals message from the specified reader or buffer.
112348
+ * @param reader Reader or buffer to decode from
112349
+ * @param [length] Message length if known beforehand
112350
+ * @returns RankSignals
112351
+ * @throws {Error} If the payload is not a reader or valid buffer
112352
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
112353
+ */
112354
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals;
112355
+
112356
+ /**
112357
+ * Decodes a RankSignals message from the specified reader or buffer, length delimited.
112358
+ * @param reader Reader or buffer to decode from
112359
+ * @returns RankSignals
112360
+ * @throws {Error} If the payload is not a reader or valid buffer
112361
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
112362
+ */
112363
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals;
112364
+
112365
+ /**
112366
+ * Verifies a RankSignals message.
112367
+ * @param message Plain object to verify
112368
+ * @returns `null` if valid, otherwise the reason why it is not
112369
+ */
112370
+ public static verify(message: { [k: string]: any }): (string|null);
112371
+
112372
+ /**
112373
+ * Creates a RankSignals message from a plain object. Also converts values to their respective internal types.
112374
+ * @param object Plain object
112375
+ * @returns RankSignals
112376
+ */
112377
+ public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals;
112378
+
112379
+ /**
112380
+ * Creates a plain object from a RankSignals message. Also converts values to other types if specified.
112381
+ * @param message RankSignals
112382
+ * @param [options] Conversion options
112383
+ * @returns Plain object
112384
+ */
112385
+ public static toObject(message: google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals, options?: $protobuf.IConversionOptions): { [k: string]: any };
112386
+
112387
+ /**
112388
+ * Converts this RankSignals to JSON.
112389
+ * @returns JSON object
112390
+ */
112391
+ public toJSON(): { [k: string]: any };
112392
+
112393
+ /**
112394
+ * Gets the default type url for RankSignals
112395
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
112396
+ * @returns The default type url
112397
+ */
112398
+ public static getTypeUrl(typeUrlPrefix?: string): string;
112399
+ }
112400
+
112401
+ namespace RankSignals {
112402
+
112403
+ /** Properties of a CustomSignal. */
112404
+ interface ICustomSignal {
112405
+
112406
+ /** CustomSignal name */
112407
+ name?: (string|null);
112408
+
112409
+ /** CustomSignal value */
112410
+ value?: (number|null);
112411
+ }
112412
+
112413
+ /** Represents a CustomSignal. */
112414
+ class CustomSignal implements ICustomSignal {
112415
+
112416
+ /**
112417
+ * Constructs a new CustomSignal.
112418
+ * @param [properties] Properties to set
112419
+ */
112420
+ constructor(properties?: google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.ICustomSignal);
112421
+
112422
+ /** CustomSignal name. */
112423
+ public name: string;
112424
+
112425
+ /** CustomSignal value. */
112426
+ public value: number;
112427
+
112428
+ /**
112429
+ * Creates a new CustomSignal instance using the specified properties.
112430
+ * @param [properties] Properties to set
112431
+ * @returns CustomSignal instance
112432
+ */
112433
+ public static create(properties?: google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.ICustomSignal): google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal;
112434
+
112435
+ /**
112436
+ * Encodes the specified CustomSignal message. Does not implicitly {@link google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal.verify|verify} messages.
112437
+ * @param message CustomSignal message or plain object to encode
112438
+ * @param [writer] Writer to encode to
112439
+ * @returns Writer
112440
+ */
112441
+ public static encode(message: google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.ICustomSignal, writer?: $protobuf.Writer): $protobuf.Writer;
112442
+
112443
+ /**
112444
+ * Encodes the specified CustomSignal message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal.verify|verify} messages.
112445
+ * @param message CustomSignal message or plain object to encode
112446
+ * @param [writer] Writer to encode to
112447
+ * @returns Writer
112448
+ */
112449
+ public static encodeDelimited(message: google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.ICustomSignal, writer?: $protobuf.Writer): $protobuf.Writer;
112450
+
112451
+ /**
112452
+ * Decodes a CustomSignal message from the specified reader or buffer.
112453
+ * @param reader Reader or buffer to decode from
112454
+ * @param [length] Message length if known beforehand
112455
+ * @returns CustomSignal
112456
+ * @throws {Error} If the payload is not a reader or valid buffer
112457
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
112458
+ */
112459
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal;
112460
+
112461
+ /**
112462
+ * Decodes a CustomSignal message from the specified reader or buffer, length delimited.
112463
+ * @param reader Reader or buffer to decode from
112464
+ * @returns CustomSignal
112465
+ * @throws {Error} If the payload is not a reader or valid buffer
112466
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
112467
+ */
112468
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal;
112469
+
112470
+ /**
112471
+ * Verifies a CustomSignal message.
112472
+ * @param message Plain object to verify
112473
+ * @returns `null` if valid, otherwise the reason why it is not
112474
+ */
112475
+ public static verify(message: { [k: string]: any }): (string|null);
112476
+
112477
+ /**
112478
+ * Creates a CustomSignal message from a plain object. Also converts values to their respective internal types.
112479
+ * @param object Plain object
112480
+ * @returns CustomSignal
112481
+ */
112482
+ public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal;
112483
+
112484
+ /**
112485
+ * Creates a plain object from a CustomSignal message. Also converts values to other types if specified.
112486
+ * @param message CustomSignal
112487
+ * @param [options] Conversion options
112488
+ * @returns Plain object
112489
+ */
112490
+ public static toObject(message: google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal, options?: $protobuf.IConversionOptions): { [k: string]: any };
112491
+
112492
+ /**
112493
+ * Converts this CustomSignal to JSON.
112494
+ * @returns JSON object
112495
+ */
112496
+ public toJSON(): { [k: string]: any };
112497
+
112498
+ /**
112499
+ * Gets the default type url for CustomSignal
112500
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
112501
+ * @returns The default type url
112502
+ */
112503
+ public static getTypeUrl(typeUrlPrefix?: string): string;
112504
+ }
112505
+ }
112506
+ }
112507
+
111683
112508
  /** Properties of a Facet. */
111684
112509
  interface IFacet {
111685
112510