@google-cloud/discoveryengine 1.4.1 → 1.6.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.
Files changed (48) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +2 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/rank_service.proto +115 -0
  4. package/build/protos/protos.d.ts +384 -0
  5. package/build/protos/protos.js +906 -0
  6. package/build/protos/protos.json +90 -1
  7. package/build/src/v1/completion_service_client.js +10 -7
  8. package/build/src/v1/conversational_search_service_client.js +10 -7
  9. package/build/src/v1/data_store_service_client.js +10 -7
  10. package/build/src/v1/document_service_client.js +10 -7
  11. package/build/src/v1/engine_service_client.js +10 -7
  12. package/build/src/v1/schema_service_client.js +10 -7
  13. package/build/src/v1/search_service_client.js +10 -7
  14. package/build/src/v1/site_search_engine_service_client.js +10 -7
  15. package/build/src/v1/user_event_service_client.js +10 -7
  16. package/build/src/v1alpha/acl_config_service_client.js +10 -7
  17. package/build/src/v1alpha/chunk_service_client.js +10 -7
  18. package/build/src/v1alpha/completion_service_client.js +10 -7
  19. package/build/src/v1alpha/conversational_search_service_client.js +10 -7
  20. package/build/src/v1alpha/data_store_service_client.js +10 -7
  21. package/build/src/v1alpha/document_service_client.js +10 -7
  22. package/build/src/v1alpha/engine_service_client.js +10 -7
  23. package/build/src/v1alpha/estimate_billing_service_client.js +10 -7
  24. package/build/src/v1alpha/index.d.ts +1 -0
  25. package/build/src/v1alpha/index.js +3 -1
  26. package/build/src/v1alpha/rank_service_client.d.ts +1254 -0
  27. package/build/src/v1alpha/rank_service_client.js +1796 -0
  28. package/build/src/v1alpha/rank_service_client_config.json +30 -0
  29. package/build/src/v1alpha/recommendation_service_client.js +10 -7
  30. package/build/src/v1alpha/schema_service_client.js +10 -7
  31. package/build/src/v1alpha/search_service_client.js +10 -7
  32. package/build/src/v1alpha/search_tuning_service_client.js +10 -7
  33. package/build/src/v1alpha/serving_config_service_client.js +10 -7
  34. package/build/src/v1alpha/site_search_engine_service_client.js +10 -7
  35. package/build/src/v1alpha/user_event_service_client.js +10 -7
  36. package/build/src/v1beta/completion_service_client.js +10 -7
  37. package/build/src/v1beta/conversational_search_service_client.js +10 -7
  38. package/build/src/v1beta/data_store_service_client.js +10 -7
  39. package/build/src/v1beta/document_service_client.js +10 -7
  40. package/build/src/v1beta/engine_service_client.js +10 -7
  41. package/build/src/v1beta/recommendation_service_client.js +10 -7
  42. package/build/src/v1beta/schema_service_client.js +10 -7
  43. package/build/src/v1beta/search_service_client.js +10 -7
  44. package/build/src/v1beta/search_tuning_service_client.js +10 -7
  45. package/build/src/v1beta/serving_config_service_client.js +10 -7
  46. package/build/src/v1beta/site_search_engine_service_client.js +10 -7
  47. package/build/src/v1beta/user_event_service_client.js +10 -7
  48. package/package.json +1 -1
@@ -104470,6 +104470,912 @@
104470
104470
  return CollectUserEventRequest;
104471
104471
  })();
104472
104472
 
104473
+ v1alpha.RankService = (function() {
104474
+
104475
+ /**
104476
+ * Constructs a new RankService service.
104477
+ * @memberof google.cloud.discoveryengine.v1alpha
104478
+ * @classdesc Represents a RankService
104479
+ * @extends $protobuf.rpc.Service
104480
+ * @constructor
104481
+ * @param {$protobuf.RPCImpl} rpcImpl RPC implementation
104482
+ * @param {boolean} [requestDelimited=false] Whether requests are length-delimited
104483
+ * @param {boolean} [responseDelimited=false] Whether responses are length-delimited
104484
+ */
104485
+ function RankService(rpcImpl, requestDelimited, responseDelimited) {
104486
+ $protobuf.rpc.Service.call(this, rpcImpl, requestDelimited, responseDelimited);
104487
+ }
104488
+
104489
+ (RankService.prototype = Object.create($protobuf.rpc.Service.prototype)).constructor = RankService;
104490
+
104491
+ /**
104492
+ * Creates new RankService service using the specified rpc implementation.
104493
+ * @function create
104494
+ * @memberof google.cloud.discoveryengine.v1alpha.RankService
104495
+ * @static
104496
+ * @param {$protobuf.RPCImpl} rpcImpl RPC implementation
104497
+ * @param {boolean} [requestDelimited=false] Whether requests are length-delimited
104498
+ * @param {boolean} [responseDelimited=false] Whether responses are length-delimited
104499
+ * @returns {RankService} RPC service. Useful where requests and/or responses are streamed.
104500
+ */
104501
+ RankService.create = function create(rpcImpl, requestDelimited, responseDelimited) {
104502
+ return new this(rpcImpl, requestDelimited, responseDelimited);
104503
+ };
104504
+
104505
+ /**
104506
+ * Callback as used by {@link google.cloud.discoveryengine.v1alpha.RankService|rank}.
104507
+ * @memberof google.cloud.discoveryengine.v1alpha.RankService
104508
+ * @typedef RankCallback
104509
+ * @type {function}
104510
+ * @param {Error|null} error Error, if any
104511
+ * @param {google.cloud.discoveryengine.v1alpha.RankResponse} [response] RankResponse
104512
+ */
104513
+
104514
+ /**
104515
+ * Calls Rank.
104516
+ * @function rank
104517
+ * @memberof google.cloud.discoveryengine.v1alpha.RankService
104518
+ * @instance
104519
+ * @param {google.cloud.discoveryengine.v1alpha.IRankRequest} request RankRequest message or plain object
104520
+ * @param {google.cloud.discoveryengine.v1alpha.RankService.RankCallback} callback Node-style callback called with the error, if any, and RankResponse
104521
+ * @returns {undefined}
104522
+ * @variation 1
104523
+ */
104524
+ Object.defineProperty(RankService.prototype.rank = function rank(request, callback) {
104525
+ return this.rpcCall(rank, $root.google.cloud.discoveryengine.v1alpha.RankRequest, $root.google.cloud.discoveryengine.v1alpha.RankResponse, request, callback);
104526
+ }, "name", { value: "Rank" });
104527
+
104528
+ /**
104529
+ * Calls Rank.
104530
+ * @function rank
104531
+ * @memberof google.cloud.discoveryengine.v1alpha.RankService
104532
+ * @instance
104533
+ * @param {google.cloud.discoveryengine.v1alpha.IRankRequest} request RankRequest message or plain object
104534
+ * @returns {Promise<google.cloud.discoveryengine.v1alpha.RankResponse>} Promise
104535
+ * @variation 2
104536
+ */
104537
+
104538
+ return RankService;
104539
+ })();
104540
+
104541
+ v1alpha.RankingRecord = (function() {
104542
+
104543
+ /**
104544
+ * Properties of a RankingRecord.
104545
+ * @memberof google.cloud.discoveryengine.v1alpha
104546
+ * @interface IRankingRecord
104547
+ * @property {string|null} [id] RankingRecord id
104548
+ * @property {string|null} [title] RankingRecord title
104549
+ * @property {string|null} [content] RankingRecord content
104550
+ * @property {number|null} [score] RankingRecord score
104551
+ */
104552
+
104553
+ /**
104554
+ * Constructs a new RankingRecord.
104555
+ * @memberof google.cloud.discoveryengine.v1alpha
104556
+ * @classdesc Represents a RankingRecord.
104557
+ * @implements IRankingRecord
104558
+ * @constructor
104559
+ * @param {google.cloud.discoveryengine.v1alpha.IRankingRecord=} [properties] Properties to set
104560
+ */
104561
+ function RankingRecord(properties) {
104562
+ if (properties)
104563
+ for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
104564
+ if (properties[keys[i]] != null)
104565
+ this[keys[i]] = properties[keys[i]];
104566
+ }
104567
+
104568
+ /**
104569
+ * RankingRecord id.
104570
+ * @member {string} id
104571
+ * @memberof google.cloud.discoveryengine.v1alpha.RankingRecord
104572
+ * @instance
104573
+ */
104574
+ RankingRecord.prototype.id = "";
104575
+
104576
+ /**
104577
+ * RankingRecord title.
104578
+ * @member {string} title
104579
+ * @memberof google.cloud.discoveryengine.v1alpha.RankingRecord
104580
+ * @instance
104581
+ */
104582
+ RankingRecord.prototype.title = "";
104583
+
104584
+ /**
104585
+ * RankingRecord content.
104586
+ * @member {string} content
104587
+ * @memberof google.cloud.discoveryengine.v1alpha.RankingRecord
104588
+ * @instance
104589
+ */
104590
+ RankingRecord.prototype.content = "";
104591
+
104592
+ /**
104593
+ * RankingRecord score.
104594
+ * @member {number} score
104595
+ * @memberof google.cloud.discoveryengine.v1alpha.RankingRecord
104596
+ * @instance
104597
+ */
104598
+ RankingRecord.prototype.score = 0;
104599
+
104600
+ /**
104601
+ * Creates a new RankingRecord instance using the specified properties.
104602
+ * @function create
104603
+ * @memberof google.cloud.discoveryengine.v1alpha.RankingRecord
104604
+ * @static
104605
+ * @param {google.cloud.discoveryengine.v1alpha.IRankingRecord=} [properties] Properties to set
104606
+ * @returns {google.cloud.discoveryengine.v1alpha.RankingRecord} RankingRecord instance
104607
+ */
104608
+ RankingRecord.create = function create(properties) {
104609
+ return new RankingRecord(properties);
104610
+ };
104611
+
104612
+ /**
104613
+ * Encodes the specified RankingRecord message. Does not implicitly {@link google.cloud.discoveryengine.v1alpha.RankingRecord.verify|verify} messages.
104614
+ * @function encode
104615
+ * @memberof google.cloud.discoveryengine.v1alpha.RankingRecord
104616
+ * @static
104617
+ * @param {google.cloud.discoveryengine.v1alpha.IRankingRecord} message RankingRecord message or plain object to encode
104618
+ * @param {$protobuf.Writer} [writer] Writer to encode to
104619
+ * @returns {$protobuf.Writer} Writer
104620
+ */
104621
+ RankingRecord.encode = function encode(message, writer) {
104622
+ if (!writer)
104623
+ writer = $Writer.create();
104624
+ if (message.id != null && Object.hasOwnProperty.call(message, "id"))
104625
+ writer.uint32(/* id 1, wireType 2 =*/10).string(message.id);
104626
+ if (message.title != null && Object.hasOwnProperty.call(message, "title"))
104627
+ writer.uint32(/* id 2, wireType 2 =*/18).string(message.title);
104628
+ if (message.content != null && Object.hasOwnProperty.call(message, "content"))
104629
+ writer.uint32(/* id 3, wireType 2 =*/26).string(message.content);
104630
+ if (message.score != null && Object.hasOwnProperty.call(message, "score"))
104631
+ writer.uint32(/* id 4, wireType 5 =*/37).float(message.score);
104632
+ return writer;
104633
+ };
104634
+
104635
+ /**
104636
+ * Encodes the specified RankingRecord message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1alpha.RankingRecord.verify|verify} messages.
104637
+ * @function encodeDelimited
104638
+ * @memberof google.cloud.discoveryengine.v1alpha.RankingRecord
104639
+ * @static
104640
+ * @param {google.cloud.discoveryengine.v1alpha.IRankingRecord} message RankingRecord message or plain object to encode
104641
+ * @param {$protobuf.Writer} [writer] Writer to encode to
104642
+ * @returns {$protobuf.Writer} Writer
104643
+ */
104644
+ RankingRecord.encodeDelimited = function encodeDelimited(message, writer) {
104645
+ return this.encode(message, writer).ldelim();
104646
+ };
104647
+
104648
+ /**
104649
+ * Decodes a RankingRecord message from the specified reader or buffer.
104650
+ * @function decode
104651
+ * @memberof google.cloud.discoveryengine.v1alpha.RankingRecord
104652
+ * @static
104653
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
104654
+ * @param {number} [length] Message length if known beforehand
104655
+ * @returns {google.cloud.discoveryengine.v1alpha.RankingRecord} RankingRecord
104656
+ * @throws {Error} If the payload is not a reader or valid buffer
104657
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
104658
+ */
104659
+ RankingRecord.decode = function decode(reader, length) {
104660
+ if (!(reader instanceof $Reader))
104661
+ reader = $Reader.create(reader);
104662
+ var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.discoveryengine.v1alpha.RankingRecord();
104663
+ while (reader.pos < end) {
104664
+ var tag = reader.uint32();
104665
+ switch (tag >>> 3) {
104666
+ case 1: {
104667
+ message.id = reader.string();
104668
+ break;
104669
+ }
104670
+ case 2: {
104671
+ message.title = reader.string();
104672
+ break;
104673
+ }
104674
+ case 3: {
104675
+ message.content = reader.string();
104676
+ break;
104677
+ }
104678
+ case 4: {
104679
+ message.score = reader.float();
104680
+ break;
104681
+ }
104682
+ default:
104683
+ reader.skipType(tag & 7);
104684
+ break;
104685
+ }
104686
+ }
104687
+ return message;
104688
+ };
104689
+
104690
+ /**
104691
+ * Decodes a RankingRecord message from the specified reader or buffer, length delimited.
104692
+ * @function decodeDelimited
104693
+ * @memberof google.cloud.discoveryengine.v1alpha.RankingRecord
104694
+ * @static
104695
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
104696
+ * @returns {google.cloud.discoveryengine.v1alpha.RankingRecord} RankingRecord
104697
+ * @throws {Error} If the payload is not a reader or valid buffer
104698
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
104699
+ */
104700
+ RankingRecord.decodeDelimited = function decodeDelimited(reader) {
104701
+ if (!(reader instanceof $Reader))
104702
+ reader = new $Reader(reader);
104703
+ return this.decode(reader, reader.uint32());
104704
+ };
104705
+
104706
+ /**
104707
+ * Verifies a RankingRecord message.
104708
+ * @function verify
104709
+ * @memberof google.cloud.discoveryengine.v1alpha.RankingRecord
104710
+ * @static
104711
+ * @param {Object.<string,*>} message Plain object to verify
104712
+ * @returns {string|null} `null` if valid, otherwise the reason why it is not
104713
+ */
104714
+ RankingRecord.verify = function verify(message) {
104715
+ if (typeof message !== "object" || message === null)
104716
+ return "object expected";
104717
+ if (message.id != null && message.hasOwnProperty("id"))
104718
+ if (!$util.isString(message.id))
104719
+ return "id: string expected";
104720
+ if (message.title != null && message.hasOwnProperty("title"))
104721
+ if (!$util.isString(message.title))
104722
+ return "title: string expected";
104723
+ if (message.content != null && message.hasOwnProperty("content"))
104724
+ if (!$util.isString(message.content))
104725
+ return "content: string expected";
104726
+ if (message.score != null && message.hasOwnProperty("score"))
104727
+ if (typeof message.score !== "number")
104728
+ return "score: number expected";
104729
+ return null;
104730
+ };
104731
+
104732
+ /**
104733
+ * Creates a RankingRecord message from a plain object. Also converts values to their respective internal types.
104734
+ * @function fromObject
104735
+ * @memberof google.cloud.discoveryengine.v1alpha.RankingRecord
104736
+ * @static
104737
+ * @param {Object.<string,*>} object Plain object
104738
+ * @returns {google.cloud.discoveryengine.v1alpha.RankingRecord} RankingRecord
104739
+ */
104740
+ RankingRecord.fromObject = function fromObject(object) {
104741
+ if (object instanceof $root.google.cloud.discoveryengine.v1alpha.RankingRecord)
104742
+ return object;
104743
+ var message = new $root.google.cloud.discoveryengine.v1alpha.RankingRecord();
104744
+ if (object.id != null)
104745
+ message.id = String(object.id);
104746
+ if (object.title != null)
104747
+ message.title = String(object.title);
104748
+ if (object.content != null)
104749
+ message.content = String(object.content);
104750
+ if (object.score != null)
104751
+ message.score = Number(object.score);
104752
+ return message;
104753
+ };
104754
+
104755
+ /**
104756
+ * Creates a plain object from a RankingRecord message. Also converts values to other types if specified.
104757
+ * @function toObject
104758
+ * @memberof google.cloud.discoveryengine.v1alpha.RankingRecord
104759
+ * @static
104760
+ * @param {google.cloud.discoveryengine.v1alpha.RankingRecord} message RankingRecord
104761
+ * @param {$protobuf.IConversionOptions} [options] Conversion options
104762
+ * @returns {Object.<string,*>} Plain object
104763
+ */
104764
+ RankingRecord.toObject = function toObject(message, options) {
104765
+ if (!options)
104766
+ options = {};
104767
+ var object = {};
104768
+ if (options.defaults) {
104769
+ object.id = "";
104770
+ object.title = "";
104771
+ object.content = "";
104772
+ object.score = 0;
104773
+ }
104774
+ if (message.id != null && message.hasOwnProperty("id"))
104775
+ object.id = message.id;
104776
+ if (message.title != null && message.hasOwnProperty("title"))
104777
+ object.title = message.title;
104778
+ if (message.content != null && message.hasOwnProperty("content"))
104779
+ object.content = message.content;
104780
+ if (message.score != null && message.hasOwnProperty("score"))
104781
+ object.score = options.json && !isFinite(message.score) ? String(message.score) : message.score;
104782
+ return object;
104783
+ };
104784
+
104785
+ /**
104786
+ * Converts this RankingRecord to JSON.
104787
+ * @function toJSON
104788
+ * @memberof google.cloud.discoveryengine.v1alpha.RankingRecord
104789
+ * @instance
104790
+ * @returns {Object.<string,*>} JSON object
104791
+ */
104792
+ RankingRecord.prototype.toJSON = function toJSON() {
104793
+ return this.constructor.toObject(this, $protobuf.util.toJSONOptions);
104794
+ };
104795
+
104796
+ /**
104797
+ * Gets the default type url for RankingRecord
104798
+ * @function getTypeUrl
104799
+ * @memberof google.cloud.discoveryengine.v1alpha.RankingRecord
104800
+ * @static
104801
+ * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
104802
+ * @returns {string} The default type url
104803
+ */
104804
+ RankingRecord.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
104805
+ if (typeUrlPrefix === undefined) {
104806
+ typeUrlPrefix = "type.googleapis.com";
104807
+ }
104808
+ return typeUrlPrefix + "/google.cloud.discoveryengine.v1alpha.RankingRecord";
104809
+ };
104810
+
104811
+ return RankingRecord;
104812
+ })();
104813
+
104814
+ v1alpha.RankRequest = (function() {
104815
+
104816
+ /**
104817
+ * Properties of a RankRequest.
104818
+ * @memberof google.cloud.discoveryengine.v1alpha
104819
+ * @interface IRankRequest
104820
+ * @property {string|null} [rankingConfig] RankRequest rankingConfig
104821
+ * @property {string|null} [model] RankRequest model
104822
+ * @property {number|null} [topN] RankRequest topN
104823
+ * @property {string|null} [query] RankRequest query
104824
+ * @property {Array.<google.cloud.discoveryengine.v1alpha.IRankingRecord>|null} [records] RankRequest records
104825
+ * @property {boolean|null} [ignoreRecordDetailsInResponse] RankRequest ignoreRecordDetailsInResponse
104826
+ */
104827
+
104828
+ /**
104829
+ * Constructs a new RankRequest.
104830
+ * @memberof google.cloud.discoveryengine.v1alpha
104831
+ * @classdesc Represents a RankRequest.
104832
+ * @implements IRankRequest
104833
+ * @constructor
104834
+ * @param {google.cloud.discoveryengine.v1alpha.IRankRequest=} [properties] Properties to set
104835
+ */
104836
+ function RankRequest(properties) {
104837
+ this.records = [];
104838
+ if (properties)
104839
+ for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
104840
+ if (properties[keys[i]] != null)
104841
+ this[keys[i]] = properties[keys[i]];
104842
+ }
104843
+
104844
+ /**
104845
+ * RankRequest rankingConfig.
104846
+ * @member {string} rankingConfig
104847
+ * @memberof google.cloud.discoveryengine.v1alpha.RankRequest
104848
+ * @instance
104849
+ */
104850
+ RankRequest.prototype.rankingConfig = "";
104851
+
104852
+ /**
104853
+ * RankRequest model.
104854
+ * @member {string} model
104855
+ * @memberof google.cloud.discoveryengine.v1alpha.RankRequest
104856
+ * @instance
104857
+ */
104858
+ RankRequest.prototype.model = "";
104859
+
104860
+ /**
104861
+ * RankRequest topN.
104862
+ * @member {number} topN
104863
+ * @memberof google.cloud.discoveryengine.v1alpha.RankRequest
104864
+ * @instance
104865
+ */
104866
+ RankRequest.prototype.topN = 0;
104867
+
104868
+ /**
104869
+ * RankRequest query.
104870
+ * @member {string} query
104871
+ * @memberof google.cloud.discoveryengine.v1alpha.RankRequest
104872
+ * @instance
104873
+ */
104874
+ RankRequest.prototype.query = "";
104875
+
104876
+ /**
104877
+ * RankRequest records.
104878
+ * @member {Array.<google.cloud.discoveryengine.v1alpha.IRankingRecord>} records
104879
+ * @memberof google.cloud.discoveryengine.v1alpha.RankRequest
104880
+ * @instance
104881
+ */
104882
+ RankRequest.prototype.records = $util.emptyArray;
104883
+
104884
+ /**
104885
+ * RankRequest ignoreRecordDetailsInResponse.
104886
+ * @member {boolean} ignoreRecordDetailsInResponse
104887
+ * @memberof google.cloud.discoveryengine.v1alpha.RankRequest
104888
+ * @instance
104889
+ */
104890
+ RankRequest.prototype.ignoreRecordDetailsInResponse = false;
104891
+
104892
+ /**
104893
+ * Creates a new RankRequest instance using the specified properties.
104894
+ * @function create
104895
+ * @memberof google.cloud.discoveryengine.v1alpha.RankRequest
104896
+ * @static
104897
+ * @param {google.cloud.discoveryengine.v1alpha.IRankRequest=} [properties] Properties to set
104898
+ * @returns {google.cloud.discoveryengine.v1alpha.RankRequest} RankRequest instance
104899
+ */
104900
+ RankRequest.create = function create(properties) {
104901
+ return new RankRequest(properties);
104902
+ };
104903
+
104904
+ /**
104905
+ * Encodes the specified RankRequest message. Does not implicitly {@link google.cloud.discoveryengine.v1alpha.RankRequest.verify|verify} messages.
104906
+ * @function encode
104907
+ * @memberof google.cloud.discoveryengine.v1alpha.RankRequest
104908
+ * @static
104909
+ * @param {google.cloud.discoveryengine.v1alpha.IRankRequest} message RankRequest message or plain object to encode
104910
+ * @param {$protobuf.Writer} [writer] Writer to encode to
104911
+ * @returns {$protobuf.Writer} Writer
104912
+ */
104913
+ RankRequest.encode = function encode(message, writer) {
104914
+ if (!writer)
104915
+ writer = $Writer.create();
104916
+ if (message.rankingConfig != null && Object.hasOwnProperty.call(message, "rankingConfig"))
104917
+ writer.uint32(/* id 1, wireType 2 =*/10).string(message.rankingConfig);
104918
+ if (message.model != null && Object.hasOwnProperty.call(message, "model"))
104919
+ writer.uint32(/* id 2, wireType 2 =*/18).string(message.model);
104920
+ if (message.topN != null && Object.hasOwnProperty.call(message, "topN"))
104921
+ writer.uint32(/* id 3, wireType 0 =*/24).int32(message.topN);
104922
+ if (message.query != null && Object.hasOwnProperty.call(message, "query"))
104923
+ writer.uint32(/* id 4, wireType 2 =*/34).string(message.query);
104924
+ if (message.records != null && message.records.length)
104925
+ for (var i = 0; i < message.records.length; ++i)
104926
+ $root.google.cloud.discoveryengine.v1alpha.RankingRecord.encode(message.records[i], writer.uint32(/* id 5, wireType 2 =*/42).fork()).ldelim();
104927
+ if (message.ignoreRecordDetailsInResponse != null && Object.hasOwnProperty.call(message, "ignoreRecordDetailsInResponse"))
104928
+ writer.uint32(/* id 6, wireType 0 =*/48).bool(message.ignoreRecordDetailsInResponse);
104929
+ return writer;
104930
+ };
104931
+
104932
+ /**
104933
+ * Encodes the specified RankRequest message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1alpha.RankRequest.verify|verify} messages.
104934
+ * @function encodeDelimited
104935
+ * @memberof google.cloud.discoveryengine.v1alpha.RankRequest
104936
+ * @static
104937
+ * @param {google.cloud.discoveryengine.v1alpha.IRankRequest} message RankRequest message or plain object to encode
104938
+ * @param {$protobuf.Writer} [writer] Writer to encode to
104939
+ * @returns {$protobuf.Writer} Writer
104940
+ */
104941
+ RankRequest.encodeDelimited = function encodeDelimited(message, writer) {
104942
+ return this.encode(message, writer).ldelim();
104943
+ };
104944
+
104945
+ /**
104946
+ * Decodes a RankRequest message from the specified reader or buffer.
104947
+ * @function decode
104948
+ * @memberof google.cloud.discoveryengine.v1alpha.RankRequest
104949
+ * @static
104950
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
104951
+ * @param {number} [length] Message length if known beforehand
104952
+ * @returns {google.cloud.discoveryengine.v1alpha.RankRequest} RankRequest
104953
+ * @throws {Error} If the payload is not a reader or valid buffer
104954
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
104955
+ */
104956
+ RankRequest.decode = function decode(reader, length) {
104957
+ if (!(reader instanceof $Reader))
104958
+ reader = $Reader.create(reader);
104959
+ var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.discoveryengine.v1alpha.RankRequest();
104960
+ while (reader.pos < end) {
104961
+ var tag = reader.uint32();
104962
+ switch (tag >>> 3) {
104963
+ case 1: {
104964
+ message.rankingConfig = reader.string();
104965
+ break;
104966
+ }
104967
+ case 2: {
104968
+ message.model = reader.string();
104969
+ break;
104970
+ }
104971
+ case 3: {
104972
+ message.topN = reader.int32();
104973
+ break;
104974
+ }
104975
+ case 4: {
104976
+ message.query = reader.string();
104977
+ break;
104978
+ }
104979
+ case 5: {
104980
+ if (!(message.records && message.records.length))
104981
+ message.records = [];
104982
+ message.records.push($root.google.cloud.discoveryengine.v1alpha.RankingRecord.decode(reader, reader.uint32()));
104983
+ break;
104984
+ }
104985
+ case 6: {
104986
+ message.ignoreRecordDetailsInResponse = reader.bool();
104987
+ break;
104988
+ }
104989
+ default:
104990
+ reader.skipType(tag & 7);
104991
+ break;
104992
+ }
104993
+ }
104994
+ return message;
104995
+ };
104996
+
104997
+ /**
104998
+ * Decodes a RankRequest message from the specified reader or buffer, length delimited.
104999
+ * @function decodeDelimited
105000
+ * @memberof google.cloud.discoveryengine.v1alpha.RankRequest
105001
+ * @static
105002
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
105003
+ * @returns {google.cloud.discoveryengine.v1alpha.RankRequest} RankRequest
105004
+ * @throws {Error} If the payload is not a reader or valid buffer
105005
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
105006
+ */
105007
+ RankRequest.decodeDelimited = function decodeDelimited(reader) {
105008
+ if (!(reader instanceof $Reader))
105009
+ reader = new $Reader(reader);
105010
+ return this.decode(reader, reader.uint32());
105011
+ };
105012
+
105013
+ /**
105014
+ * Verifies a RankRequest message.
105015
+ * @function verify
105016
+ * @memberof google.cloud.discoveryengine.v1alpha.RankRequest
105017
+ * @static
105018
+ * @param {Object.<string,*>} message Plain object to verify
105019
+ * @returns {string|null} `null` if valid, otherwise the reason why it is not
105020
+ */
105021
+ RankRequest.verify = function verify(message) {
105022
+ if (typeof message !== "object" || message === null)
105023
+ return "object expected";
105024
+ if (message.rankingConfig != null && message.hasOwnProperty("rankingConfig"))
105025
+ if (!$util.isString(message.rankingConfig))
105026
+ return "rankingConfig: string expected";
105027
+ if (message.model != null && message.hasOwnProperty("model"))
105028
+ if (!$util.isString(message.model))
105029
+ return "model: string expected";
105030
+ if (message.topN != null && message.hasOwnProperty("topN"))
105031
+ if (!$util.isInteger(message.topN))
105032
+ return "topN: integer expected";
105033
+ if (message.query != null && message.hasOwnProperty("query"))
105034
+ if (!$util.isString(message.query))
105035
+ return "query: string expected";
105036
+ if (message.records != null && message.hasOwnProperty("records")) {
105037
+ if (!Array.isArray(message.records))
105038
+ return "records: array expected";
105039
+ for (var i = 0; i < message.records.length; ++i) {
105040
+ var error = $root.google.cloud.discoveryengine.v1alpha.RankingRecord.verify(message.records[i]);
105041
+ if (error)
105042
+ return "records." + error;
105043
+ }
105044
+ }
105045
+ if (message.ignoreRecordDetailsInResponse != null && message.hasOwnProperty("ignoreRecordDetailsInResponse"))
105046
+ if (typeof message.ignoreRecordDetailsInResponse !== "boolean")
105047
+ return "ignoreRecordDetailsInResponse: boolean expected";
105048
+ return null;
105049
+ };
105050
+
105051
+ /**
105052
+ * Creates a RankRequest message from a plain object. Also converts values to their respective internal types.
105053
+ * @function fromObject
105054
+ * @memberof google.cloud.discoveryengine.v1alpha.RankRequest
105055
+ * @static
105056
+ * @param {Object.<string,*>} object Plain object
105057
+ * @returns {google.cloud.discoveryengine.v1alpha.RankRequest} RankRequest
105058
+ */
105059
+ RankRequest.fromObject = function fromObject(object) {
105060
+ if (object instanceof $root.google.cloud.discoveryengine.v1alpha.RankRequest)
105061
+ return object;
105062
+ var message = new $root.google.cloud.discoveryengine.v1alpha.RankRequest();
105063
+ if (object.rankingConfig != null)
105064
+ message.rankingConfig = String(object.rankingConfig);
105065
+ if (object.model != null)
105066
+ message.model = String(object.model);
105067
+ if (object.topN != null)
105068
+ message.topN = object.topN | 0;
105069
+ if (object.query != null)
105070
+ message.query = String(object.query);
105071
+ if (object.records) {
105072
+ if (!Array.isArray(object.records))
105073
+ throw TypeError(".google.cloud.discoveryengine.v1alpha.RankRequest.records: array expected");
105074
+ message.records = [];
105075
+ for (var i = 0; i < object.records.length; ++i) {
105076
+ if (typeof object.records[i] !== "object")
105077
+ throw TypeError(".google.cloud.discoveryengine.v1alpha.RankRequest.records: object expected");
105078
+ message.records[i] = $root.google.cloud.discoveryengine.v1alpha.RankingRecord.fromObject(object.records[i]);
105079
+ }
105080
+ }
105081
+ if (object.ignoreRecordDetailsInResponse != null)
105082
+ message.ignoreRecordDetailsInResponse = Boolean(object.ignoreRecordDetailsInResponse);
105083
+ return message;
105084
+ };
105085
+
105086
+ /**
105087
+ * Creates a plain object from a RankRequest message. Also converts values to other types if specified.
105088
+ * @function toObject
105089
+ * @memberof google.cloud.discoveryengine.v1alpha.RankRequest
105090
+ * @static
105091
+ * @param {google.cloud.discoveryengine.v1alpha.RankRequest} message RankRequest
105092
+ * @param {$protobuf.IConversionOptions} [options] Conversion options
105093
+ * @returns {Object.<string,*>} Plain object
105094
+ */
105095
+ RankRequest.toObject = function toObject(message, options) {
105096
+ if (!options)
105097
+ options = {};
105098
+ var object = {};
105099
+ if (options.arrays || options.defaults)
105100
+ object.records = [];
105101
+ if (options.defaults) {
105102
+ object.rankingConfig = "";
105103
+ object.model = "";
105104
+ object.topN = 0;
105105
+ object.query = "";
105106
+ object.ignoreRecordDetailsInResponse = false;
105107
+ }
105108
+ if (message.rankingConfig != null && message.hasOwnProperty("rankingConfig"))
105109
+ object.rankingConfig = message.rankingConfig;
105110
+ if (message.model != null && message.hasOwnProperty("model"))
105111
+ object.model = message.model;
105112
+ if (message.topN != null && message.hasOwnProperty("topN"))
105113
+ object.topN = message.topN;
105114
+ if (message.query != null && message.hasOwnProperty("query"))
105115
+ object.query = message.query;
105116
+ if (message.records && message.records.length) {
105117
+ object.records = [];
105118
+ for (var j = 0; j < message.records.length; ++j)
105119
+ object.records[j] = $root.google.cloud.discoveryengine.v1alpha.RankingRecord.toObject(message.records[j], options);
105120
+ }
105121
+ if (message.ignoreRecordDetailsInResponse != null && message.hasOwnProperty("ignoreRecordDetailsInResponse"))
105122
+ object.ignoreRecordDetailsInResponse = message.ignoreRecordDetailsInResponse;
105123
+ return object;
105124
+ };
105125
+
105126
+ /**
105127
+ * Converts this RankRequest to JSON.
105128
+ * @function toJSON
105129
+ * @memberof google.cloud.discoveryengine.v1alpha.RankRequest
105130
+ * @instance
105131
+ * @returns {Object.<string,*>} JSON object
105132
+ */
105133
+ RankRequest.prototype.toJSON = function toJSON() {
105134
+ return this.constructor.toObject(this, $protobuf.util.toJSONOptions);
105135
+ };
105136
+
105137
+ /**
105138
+ * Gets the default type url for RankRequest
105139
+ * @function getTypeUrl
105140
+ * @memberof google.cloud.discoveryengine.v1alpha.RankRequest
105141
+ * @static
105142
+ * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
105143
+ * @returns {string} The default type url
105144
+ */
105145
+ RankRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
105146
+ if (typeUrlPrefix === undefined) {
105147
+ typeUrlPrefix = "type.googleapis.com";
105148
+ }
105149
+ return typeUrlPrefix + "/google.cloud.discoveryengine.v1alpha.RankRequest";
105150
+ };
105151
+
105152
+ return RankRequest;
105153
+ })();
105154
+
105155
+ v1alpha.RankResponse = (function() {
105156
+
105157
+ /**
105158
+ * Properties of a RankResponse.
105159
+ * @memberof google.cloud.discoveryengine.v1alpha
105160
+ * @interface IRankResponse
105161
+ * @property {Array.<google.cloud.discoveryengine.v1alpha.IRankingRecord>|null} [records] RankResponse records
105162
+ */
105163
+
105164
+ /**
105165
+ * Constructs a new RankResponse.
105166
+ * @memberof google.cloud.discoveryengine.v1alpha
105167
+ * @classdesc Represents a RankResponse.
105168
+ * @implements IRankResponse
105169
+ * @constructor
105170
+ * @param {google.cloud.discoveryengine.v1alpha.IRankResponse=} [properties] Properties to set
105171
+ */
105172
+ function RankResponse(properties) {
105173
+ this.records = [];
105174
+ if (properties)
105175
+ for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
105176
+ if (properties[keys[i]] != null)
105177
+ this[keys[i]] = properties[keys[i]];
105178
+ }
105179
+
105180
+ /**
105181
+ * RankResponse records.
105182
+ * @member {Array.<google.cloud.discoveryengine.v1alpha.IRankingRecord>} records
105183
+ * @memberof google.cloud.discoveryengine.v1alpha.RankResponse
105184
+ * @instance
105185
+ */
105186
+ RankResponse.prototype.records = $util.emptyArray;
105187
+
105188
+ /**
105189
+ * Creates a new RankResponse instance using the specified properties.
105190
+ * @function create
105191
+ * @memberof google.cloud.discoveryengine.v1alpha.RankResponse
105192
+ * @static
105193
+ * @param {google.cloud.discoveryengine.v1alpha.IRankResponse=} [properties] Properties to set
105194
+ * @returns {google.cloud.discoveryengine.v1alpha.RankResponse} RankResponse instance
105195
+ */
105196
+ RankResponse.create = function create(properties) {
105197
+ return new RankResponse(properties);
105198
+ };
105199
+
105200
+ /**
105201
+ * Encodes the specified RankResponse message. Does not implicitly {@link google.cloud.discoveryengine.v1alpha.RankResponse.verify|verify} messages.
105202
+ * @function encode
105203
+ * @memberof google.cloud.discoveryengine.v1alpha.RankResponse
105204
+ * @static
105205
+ * @param {google.cloud.discoveryengine.v1alpha.IRankResponse} message RankResponse message or plain object to encode
105206
+ * @param {$protobuf.Writer} [writer] Writer to encode to
105207
+ * @returns {$protobuf.Writer} Writer
105208
+ */
105209
+ RankResponse.encode = function encode(message, writer) {
105210
+ if (!writer)
105211
+ writer = $Writer.create();
105212
+ if (message.records != null && message.records.length)
105213
+ for (var i = 0; i < message.records.length; ++i)
105214
+ $root.google.cloud.discoveryengine.v1alpha.RankingRecord.encode(message.records[i], writer.uint32(/* id 5, wireType 2 =*/42).fork()).ldelim();
105215
+ return writer;
105216
+ };
105217
+
105218
+ /**
105219
+ * Encodes the specified RankResponse message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1alpha.RankResponse.verify|verify} messages.
105220
+ * @function encodeDelimited
105221
+ * @memberof google.cloud.discoveryengine.v1alpha.RankResponse
105222
+ * @static
105223
+ * @param {google.cloud.discoveryengine.v1alpha.IRankResponse} message RankResponse message or plain object to encode
105224
+ * @param {$protobuf.Writer} [writer] Writer to encode to
105225
+ * @returns {$protobuf.Writer} Writer
105226
+ */
105227
+ RankResponse.encodeDelimited = function encodeDelimited(message, writer) {
105228
+ return this.encode(message, writer).ldelim();
105229
+ };
105230
+
105231
+ /**
105232
+ * Decodes a RankResponse message from the specified reader or buffer.
105233
+ * @function decode
105234
+ * @memberof google.cloud.discoveryengine.v1alpha.RankResponse
105235
+ * @static
105236
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
105237
+ * @param {number} [length] Message length if known beforehand
105238
+ * @returns {google.cloud.discoveryengine.v1alpha.RankResponse} RankResponse
105239
+ * @throws {Error} If the payload is not a reader or valid buffer
105240
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
105241
+ */
105242
+ RankResponse.decode = function decode(reader, length) {
105243
+ if (!(reader instanceof $Reader))
105244
+ reader = $Reader.create(reader);
105245
+ var end = length === undefined ? reader.len : reader.pos + length, message = new $root.google.cloud.discoveryengine.v1alpha.RankResponse();
105246
+ while (reader.pos < end) {
105247
+ var tag = reader.uint32();
105248
+ switch (tag >>> 3) {
105249
+ case 5: {
105250
+ if (!(message.records && message.records.length))
105251
+ message.records = [];
105252
+ message.records.push($root.google.cloud.discoveryengine.v1alpha.RankingRecord.decode(reader, reader.uint32()));
105253
+ break;
105254
+ }
105255
+ default:
105256
+ reader.skipType(tag & 7);
105257
+ break;
105258
+ }
105259
+ }
105260
+ return message;
105261
+ };
105262
+
105263
+ /**
105264
+ * Decodes a RankResponse message from the specified reader or buffer, length delimited.
105265
+ * @function decodeDelimited
105266
+ * @memberof google.cloud.discoveryengine.v1alpha.RankResponse
105267
+ * @static
105268
+ * @param {$protobuf.Reader|Uint8Array} reader Reader or buffer to decode from
105269
+ * @returns {google.cloud.discoveryengine.v1alpha.RankResponse} RankResponse
105270
+ * @throws {Error} If the payload is not a reader or valid buffer
105271
+ * @throws {$protobuf.util.ProtocolError} If required fields are missing
105272
+ */
105273
+ RankResponse.decodeDelimited = function decodeDelimited(reader) {
105274
+ if (!(reader instanceof $Reader))
105275
+ reader = new $Reader(reader);
105276
+ return this.decode(reader, reader.uint32());
105277
+ };
105278
+
105279
+ /**
105280
+ * Verifies a RankResponse message.
105281
+ * @function verify
105282
+ * @memberof google.cloud.discoveryengine.v1alpha.RankResponse
105283
+ * @static
105284
+ * @param {Object.<string,*>} message Plain object to verify
105285
+ * @returns {string|null} `null` if valid, otherwise the reason why it is not
105286
+ */
105287
+ RankResponse.verify = function verify(message) {
105288
+ if (typeof message !== "object" || message === null)
105289
+ return "object expected";
105290
+ if (message.records != null && message.hasOwnProperty("records")) {
105291
+ if (!Array.isArray(message.records))
105292
+ return "records: array expected";
105293
+ for (var i = 0; i < message.records.length; ++i) {
105294
+ var error = $root.google.cloud.discoveryengine.v1alpha.RankingRecord.verify(message.records[i]);
105295
+ if (error)
105296
+ return "records." + error;
105297
+ }
105298
+ }
105299
+ return null;
105300
+ };
105301
+
105302
+ /**
105303
+ * Creates a RankResponse message from a plain object. Also converts values to their respective internal types.
105304
+ * @function fromObject
105305
+ * @memberof google.cloud.discoveryengine.v1alpha.RankResponse
105306
+ * @static
105307
+ * @param {Object.<string,*>} object Plain object
105308
+ * @returns {google.cloud.discoveryengine.v1alpha.RankResponse} RankResponse
105309
+ */
105310
+ RankResponse.fromObject = function fromObject(object) {
105311
+ if (object instanceof $root.google.cloud.discoveryengine.v1alpha.RankResponse)
105312
+ return object;
105313
+ var message = new $root.google.cloud.discoveryengine.v1alpha.RankResponse();
105314
+ if (object.records) {
105315
+ if (!Array.isArray(object.records))
105316
+ throw TypeError(".google.cloud.discoveryengine.v1alpha.RankResponse.records: array expected");
105317
+ message.records = [];
105318
+ for (var i = 0; i < object.records.length; ++i) {
105319
+ if (typeof object.records[i] !== "object")
105320
+ throw TypeError(".google.cloud.discoveryengine.v1alpha.RankResponse.records: object expected");
105321
+ message.records[i] = $root.google.cloud.discoveryengine.v1alpha.RankingRecord.fromObject(object.records[i]);
105322
+ }
105323
+ }
105324
+ return message;
105325
+ };
105326
+
105327
+ /**
105328
+ * Creates a plain object from a RankResponse message. Also converts values to other types if specified.
105329
+ * @function toObject
105330
+ * @memberof google.cloud.discoveryengine.v1alpha.RankResponse
105331
+ * @static
105332
+ * @param {google.cloud.discoveryengine.v1alpha.RankResponse} message RankResponse
105333
+ * @param {$protobuf.IConversionOptions} [options] Conversion options
105334
+ * @returns {Object.<string,*>} Plain object
105335
+ */
105336
+ RankResponse.toObject = function toObject(message, options) {
105337
+ if (!options)
105338
+ options = {};
105339
+ var object = {};
105340
+ if (options.arrays || options.defaults)
105341
+ object.records = [];
105342
+ if (message.records && message.records.length) {
105343
+ object.records = [];
105344
+ for (var j = 0; j < message.records.length; ++j)
105345
+ object.records[j] = $root.google.cloud.discoveryengine.v1alpha.RankingRecord.toObject(message.records[j], options);
105346
+ }
105347
+ return object;
105348
+ };
105349
+
105350
+ /**
105351
+ * Converts this RankResponse to JSON.
105352
+ * @function toJSON
105353
+ * @memberof google.cloud.discoveryengine.v1alpha.RankResponse
105354
+ * @instance
105355
+ * @returns {Object.<string,*>} JSON object
105356
+ */
105357
+ RankResponse.prototype.toJSON = function toJSON() {
105358
+ return this.constructor.toObject(this, $protobuf.util.toJSONOptions);
105359
+ };
105360
+
105361
+ /**
105362
+ * Gets the default type url for RankResponse
105363
+ * @function getTypeUrl
105364
+ * @memberof google.cloud.discoveryengine.v1alpha.RankResponse
105365
+ * @static
105366
+ * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
105367
+ * @returns {string} The default type url
105368
+ */
105369
+ RankResponse.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
105370
+ if (typeUrlPrefix === undefined) {
105371
+ typeUrlPrefix = "type.googleapis.com";
105372
+ }
105373
+ return typeUrlPrefix + "/google.cloud.discoveryengine.v1alpha.RankResponse";
105374
+ };
105375
+
105376
+ return RankResponse;
105377
+ })();
105378
+
104473
105379
  return v1alpha;
104474
105380
  })();
104475
105381