@google-cloud/discoveryengine 3.2.0 → 3.3.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.
@@ -5236,6 +5236,9 @@ export namespace google {
5236
5236
  /** SearchRequest dataStoreSpecs */
5237
5237
  dataStoreSpecs?: (google.cloud.discoveryengine.v1.SearchRequest.IDataStoreSpec[]|null);
5238
5238
 
5239
+ /** SearchRequest numResultsPerDataStore */
5240
+ numResultsPerDataStore?: (number|null);
5241
+
5239
5242
  /** SearchRequest filter */
5240
5243
  filter?: (string|null);
5241
5244
 
@@ -5310,6 +5313,15 @@ export namespace google {
5310
5313
 
5311
5314
  /** SearchRequest relevanceScoreSpec */
5312
5315
  relevanceScoreSpec?: (google.cloud.discoveryengine.v1.SearchRequest.IRelevanceScoreSpec|null);
5316
+
5317
+ /** SearchRequest searchAddonSpec */
5318
+ searchAddonSpec?: (google.cloud.discoveryengine.v1.SearchRequest.ISearchAddonSpec|null);
5319
+
5320
+ /** SearchRequest customRankingParams */
5321
+ customRankingParams?: (google.cloud.discoveryengine.v1.SearchRequest.ICustomRankingParams|null);
5322
+
5323
+ /** SearchRequest entity */
5324
+ entity?: (string|null);
5313
5325
  }
5314
5326
 
5315
5327
  /** Represents a SearchRequest. */
@@ -5351,6 +5363,9 @@ export namespace google {
5351
5363
  /** SearchRequest dataStoreSpecs. */
5352
5364
  public dataStoreSpecs: google.cloud.discoveryengine.v1.SearchRequest.IDataStoreSpec[];
5353
5365
 
5366
+ /** SearchRequest numResultsPerDataStore. */
5367
+ public numResultsPerDataStore: number;
5368
+
5354
5369
  /** SearchRequest filter. */
5355
5370
  public filter: string;
5356
5371
 
@@ -5426,6 +5441,15 @@ export namespace google {
5426
5441
  /** SearchRequest relevanceScoreSpec. */
5427
5442
  public relevanceScoreSpec?: (google.cloud.discoveryengine.v1.SearchRequest.IRelevanceScoreSpec|null);
5428
5443
 
5444
+ /** SearchRequest searchAddonSpec. */
5445
+ public searchAddonSpec?: (google.cloud.discoveryengine.v1.SearchRequest.ISearchAddonSpec|null);
5446
+
5447
+ /** SearchRequest customRankingParams. */
5448
+ public customRankingParams?: (google.cloud.discoveryengine.v1.SearchRequest.ICustomRankingParams|null);
5449
+
5450
+ /** SearchRequest entity. */
5451
+ public entity: string;
5452
+
5429
5453
  /**
5430
5454
  * Creates a new SearchRequest instance using the specified properties.
5431
5455
  * @param [properties] Properties to set
@@ -5620,6 +5644,9 @@ export namespace google {
5620
5644
 
5621
5645
  /** DataStoreSpec customSearchOperators */
5622
5646
  customSearchOperators?: (string|null);
5647
+
5648
+ /** DataStoreSpec numResults */
5649
+ numResults?: (number|null);
5623
5650
  }
5624
5651
 
5625
5652
  /** Represents a DataStoreSpec. */
@@ -5643,6 +5670,9 @@ export namespace google {
5643
5670
  /** DataStoreSpec customSearchOperators. */
5644
5671
  public customSearchOperators: string;
5645
5672
 
5673
+ /** DataStoreSpec numResults. */
5674
+ public numResults: number;
5675
+
5646
5676
  /**
5647
5677
  * Creates a new DataStoreSpec instance using the specified properties.
5648
5678
  * @param [properties] Properties to set
@@ -7587,6 +7617,12 @@ export namespace google {
7587
7617
 
7588
7618
  /** SearchAsYouTypeSpec condition */
7589
7619
  condition?: (google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition|keyof typeof google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition|null);
7620
+
7621
+ /** SearchAsYouTypeSpec fields */
7622
+ fields?: (google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.IField[]|null);
7623
+
7624
+ /** SearchAsYouTypeSpec scoreThreshold */
7625
+ scoreThreshold?: (number|null);
7590
7626
  }
7591
7627
 
7592
7628
  /** Represents a SearchAsYouTypeSpec. */
@@ -7601,6 +7637,12 @@ export namespace google {
7601
7637
  /** SearchAsYouTypeSpec condition. */
7602
7638
  public condition: (google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition|keyof typeof google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Condition);
7603
7639
 
7640
+ /** SearchAsYouTypeSpec fields. */
7641
+ public fields: google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.IField[];
7642
+
7643
+ /** SearchAsYouTypeSpec scoreThreshold. */
7644
+ public scoreThreshold?: (number|null);
7645
+
7604
7646
  /**
7605
7647
  * Creates a new SearchAsYouTypeSpec instance using the specified properties.
7606
7648
  * @param [properties] Properties to set
@@ -7681,6 +7723,109 @@ export namespace google {
7681
7723
 
7682
7724
  namespace SearchAsYouTypeSpec {
7683
7725
 
7726
+ /** Properties of a Field. */
7727
+ interface IField {
7728
+
7729
+ /** Field key */
7730
+ key?: (string|null);
7731
+
7732
+ /** Field weight */
7733
+ weight?: (number|null);
7734
+ }
7735
+
7736
+ /** Represents a Field. */
7737
+ class Field implements IField {
7738
+
7739
+ /**
7740
+ * Constructs a new Field.
7741
+ * @param [properties] Properties to set
7742
+ */
7743
+ constructor(properties?: google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.IField);
7744
+
7745
+ /** Field key. */
7746
+ public key: string;
7747
+
7748
+ /** Field weight. */
7749
+ public weight?: (number|null);
7750
+
7751
+ /**
7752
+ * Creates a new Field instance using the specified properties.
7753
+ * @param [properties] Properties to set
7754
+ * @returns Field instance
7755
+ */
7756
+ public static create(properties?: google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.IField): google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field;
7757
+
7758
+ /**
7759
+ * Encodes the specified Field message. Does not implicitly {@link google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field.verify|verify} messages.
7760
+ * @param message Field message or plain object to encode
7761
+ * @param [writer] Writer to encode to
7762
+ * @returns Writer
7763
+ */
7764
+ public static encode(message: google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.IField, writer?: $protobuf.Writer): $protobuf.Writer;
7765
+
7766
+ /**
7767
+ * Encodes the specified Field message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field.verify|verify} messages.
7768
+ * @param message Field message or plain object to encode
7769
+ * @param [writer] Writer to encode to
7770
+ * @returns Writer
7771
+ */
7772
+ public static encodeDelimited(message: google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.IField, writer?: $protobuf.Writer): $protobuf.Writer;
7773
+
7774
+ /**
7775
+ * Decodes a Field message from the specified reader or buffer.
7776
+ * @param reader Reader or buffer to decode from
7777
+ * @param [length] Message length if known beforehand
7778
+ * @returns Field
7779
+ * @throws {Error} If the payload is not a reader or valid buffer
7780
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
7781
+ */
7782
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field;
7783
+
7784
+ /**
7785
+ * Decodes a Field message from the specified reader or buffer, length delimited.
7786
+ * @param reader Reader or buffer to decode from
7787
+ * @returns Field
7788
+ * @throws {Error} If the payload is not a reader or valid buffer
7789
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
7790
+ */
7791
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field;
7792
+
7793
+ /**
7794
+ * Verifies a Field message.
7795
+ * @param message Plain object to verify
7796
+ * @returns `null` if valid, otherwise the reason why it is not
7797
+ */
7798
+ public static verify(message: { [k: string]: any }): (string|null);
7799
+
7800
+ /**
7801
+ * Creates a Field message from a plain object. Also converts values to their respective internal types.
7802
+ * @param object Plain object
7803
+ * @returns Field
7804
+ */
7805
+ public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field;
7806
+
7807
+ /**
7808
+ * Creates a plain object from a Field message. Also converts values to other types if specified.
7809
+ * @param message Field
7810
+ * @param [options] Conversion options
7811
+ * @returns Plain object
7812
+ */
7813
+ public static toObject(message: google.cloud.discoveryengine.v1.SearchRequest.SearchAsYouTypeSpec.Field, options?: $protobuf.IConversionOptions): { [k: string]: any };
7814
+
7815
+ /**
7816
+ * Converts this Field to JSON.
7817
+ * @returns JSON object
7818
+ */
7819
+ public toJSON(): { [k: string]: any };
7820
+
7821
+ /**
7822
+ * Gets the default type url for Field
7823
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
7824
+ * @returns The default type url
7825
+ */
7826
+ public static getTypeUrl(typeUrlPrefix?: string): string;
7827
+ }
7828
+
7684
7829
  /** Condition enum. */
7685
7830
  enum Condition {
7686
7831
  CONDITION_UNSPECIFIED = 0,
@@ -8019,103 +8164,6 @@ export namespace google {
8019
8164
  public static getTypeUrl(typeUrlPrefix?: string): string;
8020
8165
  }
8021
8166
 
8022
- /** Properties of a RelevanceScoreSpec. */
8023
- interface IRelevanceScoreSpec {
8024
-
8025
- /** RelevanceScoreSpec returnRelevanceScore */
8026
- returnRelevanceScore?: (boolean|null);
8027
- }
8028
-
8029
- /** Represents a RelevanceScoreSpec. */
8030
- class RelevanceScoreSpec implements IRelevanceScoreSpec {
8031
-
8032
- /**
8033
- * Constructs a new RelevanceScoreSpec.
8034
- * @param [properties] Properties to set
8035
- */
8036
- constructor(properties?: google.cloud.discoveryengine.v1.SearchRequest.IRelevanceScoreSpec);
8037
-
8038
- /** RelevanceScoreSpec returnRelevanceScore. */
8039
- public returnRelevanceScore: boolean;
8040
-
8041
- /**
8042
- * Creates a new RelevanceScoreSpec instance using the specified properties.
8043
- * @param [properties] Properties to set
8044
- * @returns RelevanceScoreSpec instance
8045
- */
8046
- public static create(properties?: google.cloud.discoveryengine.v1.SearchRequest.IRelevanceScoreSpec): google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec;
8047
-
8048
- /**
8049
- * Encodes the specified RelevanceScoreSpec message. Does not implicitly {@link google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec.verify|verify} messages.
8050
- * @param message RelevanceScoreSpec message or plain object to encode
8051
- * @param [writer] Writer to encode to
8052
- * @returns Writer
8053
- */
8054
- public static encode(message: google.cloud.discoveryengine.v1.SearchRequest.IRelevanceScoreSpec, writer?: $protobuf.Writer): $protobuf.Writer;
8055
-
8056
- /**
8057
- * Encodes the specified RelevanceScoreSpec message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec.verify|verify} messages.
8058
- * @param message RelevanceScoreSpec message or plain object to encode
8059
- * @param [writer] Writer to encode to
8060
- * @returns Writer
8061
- */
8062
- public static encodeDelimited(message: google.cloud.discoveryengine.v1.SearchRequest.IRelevanceScoreSpec, writer?: $protobuf.Writer): $protobuf.Writer;
8063
-
8064
- /**
8065
- * Decodes a RelevanceScoreSpec message from the specified reader or buffer.
8066
- * @param reader Reader or buffer to decode from
8067
- * @param [length] Message length if known beforehand
8068
- * @returns RelevanceScoreSpec
8069
- * @throws {Error} If the payload is not a reader or valid buffer
8070
- * @throws {$protobuf.util.ProtocolError} If required fields are missing
8071
- */
8072
- public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec;
8073
-
8074
- /**
8075
- * Decodes a RelevanceScoreSpec message from the specified reader or buffer, length delimited.
8076
- * @param reader Reader or buffer to decode from
8077
- * @returns RelevanceScoreSpec
8078
- * @throws {Error} If the payload is not a reader or valid buffer
8079
- * @throws {$protobuf.util.ProtocolError} If required fields are missing
8080
- */
8081
- public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec;
8082
-
8083
- /**
8084
- * Verifies a RelevanceScoreSpec message.
8085
- * @param message Plain object to verify
8086
- * @returns `null` if valid, otherwise the reason why it is not
8087
- */
8088
- public static verify(message: { [k: string]: any }): (string|null);
8089
-
8090
- /**
8091
- * Creates a RelevanceScoreSpec message from a plain object. Also converts values to their respective internal types.
8092
- * @param object Plain object
8093
- * @returns RelevanceScoreSpec
8094
- */
8095
- public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec;
8096
-
8097
- /**
8098
- * Creates a plain object from a RelevanceScoreSpec message. Also converts values to other types if specified.
8099
- * @param message RelevanceScoreSpec
8100
- * @param [options] Conversion options
8101
- * @returns Plain object
8102
- */
8103
- public static toObject(message: google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec, options?: $protobuf.IConversionOptions): { [k: string]: any };
8104
-
8105
- /**
8106
- * Converts this RelevanceScoreSpec to JSON.
8107
- * @returns JSON object
8108
- */
8109
- public toJSON(): { [k: string]: any };
8110
-
8111
- /**
8112
- * Gets the default type url for RelevanceScoreSpec
8113
- * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
8114
- * @returns The default type url
8115
- */
8116
- public static getTypeUrl(typeUrlPrefix?: string): string;
8117
- }
8118
-
8119
8167
  /** Properties of a RelevanceFilterSpec. */
8120
8168
  interface IRelevanceFilterSpec {
8121
8169
 
@@ -8328,44 +8376,347 @@ export namespace google {
8328
8376
  }
8329
8377
  }
8330
8378
 
8331
- /** RankingExpressionBackend enum. */
8332
- enum RankingExpressionBackend {
8333
- RANKING_EXPRESSION_BACKEND_UNSPECIFIED = 0,
8334
- BYOE = 1,
8335
- CLEARBOX = 2,
8336
- RANK_BY_EMBEDDING = 3,
8337
- RANK_BY_FORMULA = 4
8338
- }
8379
+ /** Properties of a RelevanceScoreSpec. */
8380
+ interface IRelevanceScoreSpec {
8339
8381
 
8340
- /** RelevanceThreshold enum. */
8341
- enum RelevanceThreshold {
8342
- RELEVANCE_THRESHOLD_UNSPECIFIED = 0,
8343
- LOWEST = 1,
8344
- LOW = 2,
8345
- MEDIUM = 3,
8346
- HIGH = 4
8382
+ /** RelevanceScoreSpec returnRelevanceScore */
8383
+ returnRelevanceScore?: (boolean|null);
8347
8384
  }
8348
- }
8349
8385
 
8350
- /** Properties of a SearchResponse. */
8351
- interface ISearchResponse {
8386
+ /** Represents a RelevanceScoreSpec. */
8387
+ class RelevanceScoreSpec implements IRelevanceScoreSpec {
8352
8388
 
8353
- /** SearchResponse results */
8354
- results?: (google.cloud.discoveryengine.v1.SearchResponse.ISearchResult[]|null);
8389
+ /**
8390
+ * Constructs a new RelevanceScoreSpec.
8391
+ * @param [properties] Properties to set
8392
+ */
8393
+ constructor(properties?: google.cloud.discoveryengine.v1.SearchRequest.IRelevanceScoreSpec);
8355
8394
 
8356
- /** SearchResponse facets */
8357
- facets?: (google.cloud.discoveryengine.v1.SearchResponse.IFacet[]|null);
8395
+ /** RelevanceScoreSpec returnRelevanceScore. */
8396
+ public returnRelevanceScore: boolean;
8358
8397
 
8359
- /** SearchResponse totalSize */
8360
- totalSize?: (number|null);
8398
+ /**
8399
+ * Creates a new RelevanceScoreSpec instance using the specified properties.
8400
+ * @param [properties] Properties to set
8401
+ * @returns RelevanceScoreSpec instance
8402
+ */
8403
+ public static create(properties?: google.cloud.discoveryengine.v1.SearchRequest.IRelevanceScoreSpec): google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec;
8361
8404
 
8362
- /** SearchResponse attributionToken */
8363
- attributionToken?: (string|null);
8405
+ /**
8406
+ * Encodes the specified RelevanceScoreSpec message. Does not implicitly {@link google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec.verify|verify} messages.
8407
+ * @param message RelevanceScoreSpec message or plain object to encode
8408
+ * @param [writer] Writer to encode to
8409
+ * @returns Writer
8410
+ */
8411
+ public static encode(message: google.cloud.discoveryengine.v1.SearchRequest.IRelevanceScoreSpec, writer?: $protobuf.Writer): $protobuf.Writer;
8364
8412
 
8365
- /** SearchResponse redirectUri */
8366
- redirectUri?: (string|null);
8413
+ /**
8414
+ * Encodes the specified RelevanceScoreSpec message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec.verify|verify} messages.
8415
+ * @param message RelevanceScoreSpec message or plain object to encode
8416
+ * @param [writer] Writer to encode to
8417
+ * @returns Writer
8418
+ */
8419
+ public static encodeDelimited(message: google.cloud.discoveryengine.v1.SearchRequest.IRelevanceScoreSpec, writer?: $protobuf.Writer): $protobuf.Writer;
8367
8420
 
8368
- /** SearchResponse nextPageToken */
8421
+ /**
8422
+ * Decodes a RelevanceScoreSpec message from the specified reader or buffer.
8423
+ * @param reader Reader or buffer to decode from
8424
+ * @param [length] Message length if known beforehand
8425
+ * @returns RelevanceScoreSpec
8426
+ * @throws {Error} If the payload is not a reader or valid buffer
8427
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
8428
+ */
8429
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec;
8430
+
8431
+ /**
8432
+ * Decodes a RelevanceScoreSpec message from the specified reader or buffer, length delimited.
8433
+ * @param reader Reader or buffer to decode from
8434
+ * @returns RelevanceScoreSpec
8435
+ * @throws {Error} If the payload is not a reader or valid buffer
8436
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
8437
+ */
8438
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec;
8439
+
8440
+ /**
8441
+ * Verifies a RelevanceScoreSpec message.
8442
+ * @param message Plain object to verify
8443
+ * @returns `null` if valid, otherwise the reason why it is not
8444
+ */
8445
+ public static verify(message: { [k: string]: any }): (string|null);
8446
+
8447
+ /**
8448
+ * Creates a RelevanceScoreSpec message from a plain object. Also converts values to their respective internal types.
8449
+ * @param object Plain object
8450
+ * @returns RelevanceScoreSpec
8451
+ */
8452
+ public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec;
8453
+
8454
+ /**
8455
+ * Creates a plain object from a RelevanceScoreSpec message. Also converts values to other types if specified.
8456
+ * @param message RelevanceScoreSpec
8457
+ * @param [options] Conversion options
8458
+ * @returns Plain object
8459
+ */
8460
+ public static toObject(message: google.cloud.discoveryengine.v1.SearchRequest.RelevanceScoreSpec, options?: $protobuf.IConversionOptions): { [k: string]: any };
8461
+
8462
+ /**
8463
+ * Converts this RelevanceScoreSpec to JSON.
8464
+ * @returns JSON object
8465
+ */
8466
+ public toJSON(): { [k: string]: any };
8467
+
8468
+ /**
8469
+ * Gets the default type url for RelevanceScoreSpec
8470
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
8471
+ * @returns The default type url
8472
+ */
8473
+ public static getTypeUrl(typeUrlPrefix?: string): string;
8474
+ }
8475
+
8476
+ /** Properties of a SearchAddonSpec. */
8477
+ interface ISearchAddonSpec {
8478
+
8479
+ /** SearchAddonSpec disableSemanticAddOn */
8480
+ disableSemanticAddOn?: (boolean|null);
8481
+
8482
+ /** SearchAddonSpec disableKpiPersonalizationAddOn */
8483
+ disableKpiPersonalizationAddOn?: (boolean|null);
8484
+
8485
+ /** SearchAddonSpec disableGenerativeAnswerAddOn */
8486
+ disableGenerativeAnswerAddOn?: (boolean|null);
8487
+ }
8488
+
8489
+ /** Represents a SearchAddonSpec. */
8490
+ class SearchAddonSpec implements ISearchAddonSpec {
8491
+
8492
+ /**
8493
+ * Constructs a new SearchAddonSpec.
8494
+ * @param [properties] Properties to set
8495
+ */
8496
+ constructor(properties?: google.cloud.discoveryengine.v1.SearchRequest.ISearchAddonSpec);
8497
+
8498
+ /** SearchAddonSpec disableSemanticAddOn. */
8499
+ public disableSemanticAddOn: boolean;
8500
+
8501
+ /** SearchAddonSpec disableKpiPersonalizationAddOn. */
8502
+ public disableKpiPersonalizationAddOn: boolean;
8503
+
8504
+ /** SearchAddonSpec disableGenerativeAnswerAddOn. */
8505
+ public disableGenerativeAnswerAddOn: boolean;
8506
+
8507
+ /**
8508
+ * Creates a new SearchAddonSpec instance using the specified properties.
8509
+ * @param [properties] Properties to set
8510
+ * @returns SearchAddonSpec instance
8511
+ */
8512
+ public static create(properties?: google.cloud.discoveryengine.v1.SearchRequest.ISearchAddonSpec): google.cloud.discoveryengine.v1.SearchRequest.SearchAddonSpec;
8513
+
8514
+ /**
8515
+ * Encodes the specified SearchAddonSpec message. Does not implicitly {@link google.cloud.discoveryengine.v1.SearchRequest.SearchAddonSpec.verify|verify} messages.
8516
+ * @param message SearchAddonSpec message or plain object to encode
8517
+ * @param [writer] Writer to encode to
8518
+ * @returns Writer
8519
+ */
8520
+ public static encode(message: google.cloud.discoveryengine.v1.SearchRequest.ISearchAddonSpec, writer?: $protobuf.Writer): $protobuf.Writer;
8521
+
8522
+ /**
8523
+ * Encodes the specified SearchAddonSpec message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1.SearchRequest.SearchAddonSpec.verify|verify} messages.
8524
+ * @param message SearchAddonSpec message or plain object to encode
8525
+ * @param [writer] Writer to encode to
8526
+ * @returns Writer
8527
+ */
8528
+ public static encodeDelimited(message: google.cloud.discoveryengine.v1.SearchRequest.ISearchAddonSpec, writer?: $protobuf.Writer): $protobuf.Writer;
8529
+
8530
+ /**
8531
+ * Decodes a SearchAddonSpec message from the specified reader or buffer.
8532
+ * @param reader Reader or buffer to decode from
8533
+ * @param [length] Message length if known beforehand
8534
+ * @returns SearchAddonSpec
8535
+ * @throws {Error} If the payload is not a reader or valid buffer
8536
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
8537
+ */
8538
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1.SearchRequest.SearchAddonSpec;
8539
+
8540
+ /**
8541
+ * Decodes a SearchAddonSpec message from the specified reader or buffer, length delimited.
8542
+ * @param reader Reader or buffer to decode from
8543
+ * @returns SearchAddonSpec
8544
+ * @throws {Error} If the payload is not a reader or valid buffer
8545
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
8546
+ */
8547
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1.SearchRequest.SearchAddonSpec;
8548
+
8549
+ /**
8550
+ * Verifies a SearchAddonSpec message.
8551
+ * @param message Plain object to verify
8552
+ * @returns `null` if valid, otherwise the reason why it is not
8553
+ */
8554
+ public static verify(message: { [k: string]: any }): (string|null);
8555
+
8556
+ /**
8557
+ * Creates a SearchAddonSpec message from a plain object. Also converts values to their respective internal types.
8558
+ * @param object Plain object
8559
+ * @returns SearchAddonSpec
8560
+ */
8561
+ public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1.SearchRequest.SearchAddonSpec;
8562
+
8563
+ /**
8564
+ * Creates a plain object from a SearchAddonSpec message. Also converts values to other types if specified.
8565
+ * @param message SearchAddonSpec
8566
+ * @param [options] Conversion options
8567
+ * @returns Plain object
8568
+ */
8569
+ public static toObject(message: google.cloud.discoveryengine.v1.SearchRequest.SearchAddonSpec, options?: $protobuf.IConversionOptions): { [k: string]: any };
8570
+
8571
+ /**
8572
+ * Converts this SearchAddonSpec to JSON.
8573
+ * @returns JSON object
8574
+ */
8575
+ public toJSON(): { [k: string]: any };
8576
+
8577
+ /**
8578
+ * Gets the default type url for SearchAddonSpec
8579
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
8580
+ * @returns The default type url
8581
+ */
8582
+ public static getTypeUrl(typeUrlPrefix?: string): string;
8583
+ }
8584
+
8585
+ /** Properties of a CustomRankingParams. */
8586
+ interface ICustomRankingParams {
8587
+
8588
+ /** CustomRankingParams expressionsToPrecompute */
8589
+ expressionsToPrecompute?: (string[]|null);
8590
+ }
8591
+
8592
+ /** Represents a CustomRankingParams. */
8593
+ class CustomRankingParams implements ICustomRankingParams {
8594
+
8595
+ /**
8596
+ * Constructs a new CustomRankingParams.
8597
+ * @param [properties] Properties to set
8598
+ */
8599
+ constructor(properties?: google.cloud.discoveryengine.v1.SearchRequest.ICustomRankingParams);
8600
+
8601
+ /** CustomRankingParams expressionsToPrecompute. */
8602
+ public expressionsToPrecompute: string[];
8603
+
8604
+ /**
8605
+ * Creates a new CustomRankingParams instance using the specified properties.
8606
+ * @param [properties] Properties to set
8607
+ * @returns CustomRankingParams instance
8608
+ */
8609
+ public static create(properties?: google.cloud.discoveryengine.v1.SearchRequest.ICustomRankingParams): google.cloud.discoveryengine.v1.SearchRequest.CustomRankingParams;
8610
+
8611
+ /**
8612
+ * Encodes the specified CustomRankingParams message. Does not implicitly {@link google.cloud.discoveryengine.v1.SearchRequest.CustomRankingParams.verify|verify} messages.
8613
+ * @param message CustomRankingParams message or plain object to encode
8614
+ * @param [writer] Writer to encode to
8615
+ * @returns Writer
8616
+ */
8617
+ public static encode(message: google.cloud.discoveryengine.v1.SearchRequest.ICustomRankingParams, writer?: $protobuf.Writer): $protobuf.Writer;
8618
+
8619
+ /**
8620
+ * Encodes the specified CustomRankingParams message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1.SearchRequest.CustomRankingParams.verify|verify} messages.
8621
+ * @param message CustomRankingParams message or plain object to encode
8622
+ * @param [writer] Writer to encode to
8623
+ * @returns Writer
8624
+ */
8625
+ public static encodeDelimited(message: google.cloud.discoveryengine.v1.SearchRequest.ICustomRankingParams, writer?: $protobuf.Writer): $protobuf.Writer;
8626
+
8627
+ /**
8628
+ * Decodes a CustomRankingParams message from the specified reader or buffer.
8629
+ * @param reader Reader or buffer to decode from
8630
+ * @param [length] Message length if known beforehand
8631
+ * @returns CustomRankingParams
8632
+ * @throws {Error} If the payload is not a reader or valid buffer
8633
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
8634
+ */
8635
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1.SearchRequest.CustomRankingParams;
8636
+
8637
+ /**
8638
+ * Decodes a CustomRankingParams message from the specified reader or buffer, length delimited.
8639
+ * @param reader Reader or buffer to decode from
8640
+ * @returns CustomRankingParams
8641
+ * @throws {Error} If the payload is not a reader or valid buffer
8642
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
8643
+ */
8644
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1.SearchRequest.CustomRankingParams;
8645
+
8646
+ /**
8647
+ * Verifies a CustomRankingParams message.
8648
+ * @param message Plain object to verify
8649
+ * @returns `null` if valid, otherwise the reason why it is not
8650
+ */
8651
+ public static verify(message: { [k: string]: any }): (string|null);
8652
+
8653
+ /**
8654
+ * Creates a CustomRankingParams message from a plain object. Also converts values to their respective internal types.
8655
+ * @param object Plain object
8656
+ * @returns CustomRankingParams
8657
+ */
8658
+ public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1.SearchRequest.CustomRankingParams;
8659
+
8660
+ /**
8661
+ * Creates a plain object from a CustomRankingParams message. Also converts values to other types if specified.
8662
+ * @param message CustomRankingParams
8663
+ * @param [options] Conversion options
8664
+ * @returns Plain object
8665
+ */
8666
+ public static toObject(message: google.cloud.discoveryengine.v1.SearchRequest.CustomRankingParams, options?: $protobuf.IConversionOptions): { [k: string]: any };
8667
+
8668
+ /**
8669
+ * Converts this CustomRankingParams to JSON.
8670
+ * @returns JSON object
8671
+ */
8672
+ public toJSON(): { [k: string]: any };
8673
+
8674
+ /**
8675
+ * Gets the default type url for CustomRankingParams
8676
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
8677
+ * @returns The default type url
8678
+ */
8679
+ public static getTypeUrl(typeUrlPrefix?: string): string;
8680
+ }
8681
+
8682
+ /** RankingExpressionBackend enum. */
8683
+ enum RankingExpressionBackend {
8684
+ RANKING_EXPRESSION_BACKEND_UNSPECIFIED = 0,
8685
+ BYOE = 1,
8686
+ CLEARBOX = 2,
8687
+ RANK_BY_EMBEDDING = 3,
8688
+ RANK_BY_FORMULA = 4
8689
+ }
8690
+
8691
+ /** RelevanceThreshold enum. */
8692
+ enum RelevanceThreshold {
8693
+ RELEVANCE_THRESHOLD_UNSPECIFIED = 0,
8694
+ LOWEST = 1,
8695
+ LOW = 2,
8696
+ MEDIUM = 3,
8697
+ HIGH = 4
8698
+ }
8699
+ }
8700
+
8701
+ /** Properties of a SearchResponse. */
8702
+ interface ISearchResponse {
8703
+
8704
+ /** SearchResponse results */
8705
+ results?: (google.cloud.discoveryengine.v1.SearchResponse.ISearchResult[]|null);
8706
+
8707
+ /** SearchResponse facets */
8708
+ facets?: (google.cloud.discoveryengine.v1.SearchResponse.IFacet[]|null);
8709
+
8710
+ /** SearchResponse totalSize */
8711
+ totalSize?: (number|null);
8712
+
8713
+ /** SearchResponse attributionToken */
8714
+ attributionToken?: (string|null);
8715
+
8716
+ /** SearchResponse redirectUri */
8717
+ redirectUri?: (string|null);
8718
+
8719
+ /** SearchResponse nextPageToken */
8369
8720
  nextPageToken?: (string|null);
8370
8721
 
8371
8722
  /** SearchResponse correctedQuery */
@@ -8374,6 +8725,9 @@ export namespace google {
8374
8725
  /** SearchResponse summary */
8375
8726
  summary?: (google.cloud.discoveryengine.v1.SearchResponse.ISummary|null);
8376
8727
 
8728
+ /** SearchResponse appliedControls */
8729
+ appliedControls?: (string[]|null);
8730
+
8377
8731
  /** SearchResponse queryExpansionInfo */
8378
8732
  queryExpansionInfo?: (google.cloud.discoveryengine.v1.SearchResponse.IQueryExpansionInfo|null);
8379
8733
 
@@ -8423,6 +8777,9 @@ export namespace google {
8423
8777
  /** SearchResponse summary. */
8424
8778
  public summary?: (google.cloud.discoveryengine.v1.SearchResponse.ISummary|null);
8425
8779
 
8780
+ /** SearchResponse appliedControls. */
8781
+ public appliedControls: string[];
8782
+
8426
8783
  /** SearchResponse queryExpansionInfo. */
8427
8784
  public queryExpansionInfo?: (google.cloud.discoveryengine.v1.SearchResponse.IQueryExpansionInfo|null);
8428
8785
 
@@ -8535,6 +8892,9 @@ export namespace google {
8535
8892
 
8536
8893
  /** SearchResult rankSignals */
8537
8894
  rankSignals?: (google.cloud.discoveryengine.v1.SearchResponse.SearchResult.IRankSignals|null);
8895
+
8896
+ /** SearchResult retrievalSignals */
8897
+ retrievalSignals?: (google.cloud.discoveryengine.v1.SearchResponse.SearchResult.IRetrievalSignals|null);
8538
8898
  }
8539
8899
 
8540
8900
  /** Represents a SearchResult. */
@@ -8561,6 +8921,9 @@ export namespace google {
8561
8921
  /** SearchResult rankSignals. */
8562
8922
  public rankSignals?: (google.cloud.discoveryengine.v1.SearchResponse.SearchResult.IRankSignals|null);
8563
8923
 
8924
+ /** SearchResult retrievalSignals. */
8925
+ public retrievalSignals?: (google.cloud.discoveryengine.v1.SearchResponse.SearchResult.IRetrievalSignals|null);
8926
+
8564
8927
  /**
8565
8928
  * Creates a new SearchResult instance using the specified properties.
8566
8929
  * @param [properties] Properties to set
@@ -8670,6 +9033,9 @@ export namespace google {
8670
9033
 
8671
9034
  /** RankSignals customSignals */
8672
9035
  customSignals?: (google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.ICustomSignal[]|null);
9036
+
9037
+ /** RankSignals precomputedExpressionValues */
9038
+ precomputedExpressionValues?: (number[]|null);
8673
9039
  }
8674
9040
 
8675
9041
  /** Represents a RankSignals. */
@@ -8708,6 +9074,9 @@ export namespace google {
8708
9074
  /** RankSignals customSignals. */
8709
9075
  public customSignals: google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.ICustomSignal[];
8710
9076
 
9077
+ /** RankSignals precomputedExpressionValues. */
9078
+ public precomputedExpressionValues: number[];
9079
+
8711
9080
  /**
8712
9081
  * Creates a new RankSignals instance using the specified properties.
8713
9082
  * @param [properties] Properties to set
@@ -8891,6 +9260,119 @@ export namespace google {
8891
9260
  public static getTypeUrl(typeUrlPrefix?: string): string;
8892
9261
  }
8893
9262
  }
9263
+
9264
+ /** Properties of a RetrievalSignals. */
9265
+ interface IRetrievalSignals {
9266
+
9267
+ /** RetrievalSignals retrievalSources */
9268
+ retrievalSources?: (google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource[]|null);
9269
+
9270
+ /** RetrievalSignals semanticRelevanceScore */
9271
+ semanticRelevanceScore?: (number|null);
9272
+ }
9273
+
9274
+ /** Represents a RetrievalSignals. */
9275
+ class RetrievalSignals implements IRetrievalSignals {
9276
+
9277
+ /**
9278
+ * Constructs a new RetrievalSignals.
9279
+ * @param [properties] Properties to set
9280
+ */
9281
+ constructor(properties?: google.cloud.discoveryengine.v1.SearchResponse.SearchResult.IRetrievalSignals);
9282
+
9283
+ /** RetrievalSignals retrievalSources. */
9284
+ public retrievalSources: google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.RetrievalSource[];
9285
+
9286
+ /** RetrievalSignals semanticRelevanceScore. */
9287
+ public semanticRelevanceScore: number;
9288
+
9289
+ /**
9290
+ * Creates a new RetrievalSignals instance using the specified properties.
9291
+ * @param [properties] Properties to set
9292
+ * @returns RetrievalSignals instance
9293
+ */
9294
+ public static create(properties?: google.cloud.discoveryengine.v1.SearchResponse.SearchResult.IRetrievalSignals): google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals;
9295
+
9296
+ /**
9297
+ * Encodes the specified RetrievalSignals message. Does not implicitly {@link google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.verify|verify} messages.
9298
+ * @param message RetrievalSignals message or plain object to encode
9299
+ * @param [writer] Writer to encode to
9300
+ * @returns Writer
9301
+ */
9302
+ public static encode(message: google.cloud.discoveryengine.v1.SearchResponse.SearchResult.IRetrievalSignals, writer?: $protobuf.Writer): $protobuf.Writer;
9303
+
9304
+ /**
9305
+ * Encodes the specified RetrievalSignals message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals.verify|verify} messages.
9306
+ * @param message RetrievalSignals message or plain object to encode
9307
+ * @param [writer] Writer to encode to
9308
+ * @returns Writer
9309
+ */
9310
+ public static encodeDelimited(message: google.cloud.discoveryengine.v1.SearchResponse.SearchResult.IRetrievalSignals, writer?: $protobuf.Writer): $protobuf.Writer;
9311
+
9312
+ /**
9313
+ * Decodes a RetrievalSignals message from the specified reader or buffer.
9314
+ * @param reader Reader or buffer to decode from
9315
+ * @param [length] Message length if known beforehand
9316
+ * @returns RetrievalSignals
9317
+ * @throws {Error} If the payload is not a reader or valid buffer
9318
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
9319
+ */
9320
+ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals;
9321
+
9322
+ /**
9323
+ * Decodes a RetrievalSignals message from the specified reader or buffer, length delimited.
9324
+ * @param reader Reader or buffer to decode from
9325
+ * @returns RetrievalSignals
9326
+ * @throws {Error} If the payload is not a reader or valid buffer
9327
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
9328
+ */
9329
+ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals;
9330
+
9331
+ /**
9332
+ * Verifies a RetrievalSignals message.
9333
+ * @param message Plain object to verify
9334
+ * @returns `null` if valid, otherwise the reason why it is not
9335
+ */
9336
+ public static verify(message: { [k: string]: any }): (string|null);
9337
+
9338
+ /**
9339
+ * Creates a RetrievalSignals message from a plain object. Also converts values to their respective internal types.
9340
+ * @param object Plain object
9341
+ * @returns RetrievalSignals
9342
+ */
9343
+ public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals;
9344
+
9345
+ /**
9346
+ * Creates a plain object from a RetrievalSignals message. Also converts values to other types if specified.
9347
+ * @param message RetrievalSignals
9348
+ * @param [options] Conversion options
9349
+ * @returns Plain object
9350
+ */
9351
+ public static toObject(message: google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RetrievalSignals, options?: $protobuf.IConversionOptions): { [k: string]: any };
9352
+
9353
+ /**
9354
+ * Converts this RetrievalSignals to JSON.
9355
+ * @returns JSON object
9356
+ */
9357
+ public toJSON(): { [k: string]: any };
9358
+
9359
+ /**
9360
+ * Gets the default type url for RetrievalSignals
9361
+ * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
9362
+ * @returns The default type url
9363
+ */
9364
+ public static getTypeUrl(typeUrlPrefix?: string): string;
9365
+ }
9366
+
9367
+ namespace RetrievalSignals {
9368
+
9369
+ /** RetrievalSource enum. */
9370
+ enum RetrievalSource {
9371
+ RETRIEVAL_SOURCE_UNSPECIFIED = 0,
9372
+ KEYWORD_SEARCH = 1,
9373
+ SEMANTIC_SEARCH = 2
9374
+ }
9375
+ }
8894
9376
  }
8895
9377
 
8896
9378
  /** Properties of a Facet. */