@google-cloud/discoveryengine 1.4.1 → 1.6.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.6.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.5.0...discoveryengine-v1.6.0) (2024-04-16)
+
+
+### Features
+
+* [Many APIs] add several fields to manage state of database encryption update ([#5188](https://github.com/googleapis/google-cloud-node/issues/5188)) ([c5ccdf9](https://github.com/googleapis/google-cloud-node/commit/c5ccdf93641e7bb6d0e5c636168fad0feafab6e3))
+
+## [1.5.0](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.4.1...discoveryengine-v1.5.0) (2024-04-05)
+
+
+### Features
+
+* [discoveryengine] support import data from Cloud Spanner, BigTable, SQL and Firestore ([#5218](https://github.com/googleapis/google-cloud-node/issues/5218)) ([cc25e93](https://github.com/googleapis/google-cloud-node/commit/cc25e935f087526738303cd94c406bd352a7b595))
+
 ## [1.4.1](https://github.com/googleapis/google-cloud-node/compare/discoveryengine-v1.4.0...discoveryengine-v1.4.1) (2024-03-12)
 
 

package/README.md

@@ -195,6 +195,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
 | Document_service.create_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.create_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.create_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | Document_service.delete_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.delete_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.delete_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | Document_service.get_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.get_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.get_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
+| Document_service.get_processed_document | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.get_processed_document.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.get_processed_document.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | Document_service.import_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.import_documents.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.import_documents.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | Document_service.list_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.list_documents.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.list_documents.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | Document_service.purge_documents | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.purge_documents.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/document_service.purge_documents.js,packages/google-cloud-discoveryengine/samples/README.md) |
@@ -208,6 +209,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
 | Engine_service.tune_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.tune_engine.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.tune_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | Engine_service.update_engine | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.update_engine.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/engine_service.update_engine.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | Estimate_billing_service.estimate_data_size | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/estimate_billing_service.estimate_data_size.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/estimate_billing_service.estimate_data_size.js,packages/google-cloud-discoveryengine/samples/README.md) |
+| Rank_service.rank | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/rank_service.rank.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/rank_service.rank.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | Recommendation_service.recommend | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/recommendation_service.recommend.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/recommendation_service.recommend.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | Schema_service.create_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.create_schema.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.create_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |
 | Schema_service.delete_schema | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.delete_schema.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-discoveryengine/samples/generated/v1alpha/schema_service.delete_schema.js,packages/google-cloud-discoveryengine/samples/README.md) |

package/build/protos/google/cloud/discoveryengine/v1alpha/rank_service.proto

@@ -0,0 +1,115 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.cloud.discoveryengine.v1alpha;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "RankServiceProto";
+option java_package = "com.google.cloud.discoveryengine.v1alpha";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
+
+// Service for ranking text records.
+service RankService {
+  option (google.api.default_host) = "discoveryengine.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Ranks a list of text records based on the given input query.
+  rpc Rank(RankRequest) returns (RankResponse) {
+    option (google.api.http) = {
+      post: "/v1alpha/{ranking_config=projects/*/locations/*/rankingConfigs/*}:rank"
+      body: "*"
+    };
+  }
+}
+
+// Record message for
+// [RankService.Rank][google.cloud.discoveryengine.v1alpha.RankService.Rank]
+// method.
+message RankingRecord {
+  // The unique ID to represent the record.
+  string id = 1;
+
+  // The title of the record. Empty by default.
+  // At least one of
+  // [title][google.cloud.discoveryengine.v1alpha.RankingRecord.title] or
+  // [content][google.cloud.discoveryengine.v1alpha.RankingRecord.content]
+  // should be set otherwise an INVALID_ARGUMENT error is thrown.
+  string title = 2;
+
+  // The content of the record. Empty by default.
+  // At least one of
+  // [title][google.cloud.discoveryengine.v1alpha.RankingRecord.title] or
+  // [content][google.cloud.discoveryengine.v1alpha.RankingRecord.content]
+  // should be set otherwise an INVALID_ARGUMENT error is thrown.
+  string content = 3;
+
+  // The score of this record based on the given query and selected model.
+  float score = 4;
+}
+
+// Request message for
+// [RankService.Rank][google.cloud.discoveryengine.v1alpha.RankService.Rank]
+// method.
+message RankRequest {
+  // Required. The resource name of the rank service config, such as
+  // `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.
+  string ranking_config = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/RankingConfig"
+    }
+  ];
+
+  // The identifier of the model to use. It is one of:
+  //
+  // * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
+  // token size 512.
+  //
+  // It is set to `semantic-ranker-512@latest` by default if unspecified.
+  string model = 2;
+
+  // The number of results to return. If this is unset or no bigger than zero,
+  // returns all results.
+  int32 top_n = 3;
+
+  // The query to use.
+  string query = 4;
+
+  // Required. A list of records to rank. At most 200 records to rank.
+  repeated RankingRecord records = 5 [(google.api.field_behavior) = REQUIRED];
+
+  // If true, the response will contain only record ID and score. By default, it
+  // is false, the response will contain record details.
+  bool ignore_record_details_in_response = 6;
+}
+
+// Response message for
+// [RankService.Rank][google.cloud.discoveryengine.v1alpha.RankService.Rank]
+// method.
+message RankResponse {
+  // A list of records sorted by descending score.
+  repeated RankingRecord records = 5;
+}

package/build/protos/protos.d.ts

@@ -43658,6 +43658,390 @@ export namespace google {
                      */
                     public static getTypeUrl(typeUrlPrefix?: string): string;
                 }
+
+                /** Represents a RankService */
+                class RankService extends $protobuf.rpc.Service {
+
+                    /**
+                     * Constructs a new RankService service.
+                     * @param rpcImpl RPC implementation
+                     * @param [requestDelimited=false] Whether requests are length-delimited
+                     * @param [responseDelimited=false] Whether responses are length-delimited
+                     */
+                    constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);
+
+                    /**
+                     * Creates new RankService service using the specified rpc implementation.
+                     * @param rpcImpl RPC implementation
+                     * @param [requestDelimited=false] Whether requests are length-delimited
+                     * @param [responseDelimited=false] Whether responses are length-delimited
+                     * @returns RPC service. Useful where requests and/or responses are streamed.
+                     */
+                    public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): RankService;
+
+                    /**
+                     * Calls Rank.
+                     * @param request RankRequest message or plain object
+                     * @param callback Node-style callback called with the error, if any, and RankResponse
+                     */
+                    public rank(request: google.cloud.discoveryengine.v1alpha.IRankRequest, callback: google.cloud.discoveryengine.v1alpha.RankService.RankCallback): void;
+
+                    /**
+                     * Calls Rank.
+                     * @param request RankRequest message or plain object
+                     * @returns Promise
+                     */
+                    public rank(request: google.cloud.discoveryengine.v1alpha.IRankRequest): Promise<google.cloud.discoveryengine.v1alpha.RankResponse>;
+                }
+
+                namespace RankService {
+
+                    /**
+                     * Callback as used by {@link google.cloud.discoveryengine.v1alpha.RankService|rank}.
+                     * @param error Error, if any
+                     * @param [response] RankResponse
+                     */
+                    type RankCallback = (error: (Error|null), response?: google.cloud.discoveryengine.v1alpha.RankResponse) => void;
+                }
+
+                /** Properties of a RankingRecord. */
+                interface IRankingRecord {
+
+                    /** RankingRecord id */
+                    id?: (string|null);
+
+                    /** RankingRecord title */
+                    title?: (string|null);
+
+                    /** RankingRecord content */
+                    content?: (string|null);
+
+                    /** RankingRecord score */
+                    score?: (number|null);
+                }
+
+                /** Represents a RankingRecord. */
+                class RankingRecord implements IRankingRecord {
+
+                    /**
+                     * Constructs a new RankingRecord.
+                     * @param [properties] Properties to set
+                     */
+                    constructor(properties?: google.cloud.discoveryengine.v1alpha.IRankingRecord);
+
+                    /** RankingRecord id. */
+                    public id: string;
+
+                    /** RankingRecord title. */
+                    public title: string;
+
+                    /** RankingRecord content. */
+                    public content: string;
+
+                    /** RankingRecord score. */
+                    public score: number;
+
+                    /**
+                     * Creates a new RankingRecord instance using the specified properties.
+                     * @param [properties] Properties to set
+                     * @returns RankingRecord instance
+                     */
+                    public static create(properties?: google.cloud.discoveryengine.v1alpha.IRankingRecord): google.cloud.discoveryengine.v1alpha.RankingRecord;
+
+                    /**
+                     * Encodes the specified RankingRecord message. Does not implicitly {@link google.cloud.discoveryengine.v1alpha.RankingRecord.verify|verify} messages.
+                     * @param message RankingRecord message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encode(message: google.cloud.discoveryengine.v1alpha.IRankingRecord, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Encodes the specified RankingRecord message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1alpha.RankingRecord.verify|verify} messages.
+                     * @param message RankingRecord message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encodeDelimited(message: google.cloud.discoveryengine.v1alpha.IRankingRecord, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Decodes a RankingRecord message from the specified reader or buffer.
+                     * @param reader Reader or buffer to decode from
+                     * @param [length] Message length if known beforehand
+                     * @returns RankingRecord
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1alpha.RankingRecord;
+
+                    /**
+                     * Decodes a RankingRecord message from the specified reader or buffer, length delimited.
+                     * @param reader Reader or buffer to decode from
+                     * @returns RankingRecord
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1alpha.RankingRecord;
+
+                    /**
+                     * Verifies a RankingRecord message.
+                     * @param message Plain object to verify
+                     * @returns `null` if valid, otherwise the reason why it is not
+                     */
+                    public static verify(message: { [k: string]: any }): (string|null);
+
+                    /**
+                     * Creates a RankingRecord message from a plain object. Also converts values to their respective internal types.
+                     * @param object Plain object
+                     * @returns RankingRecord
+                     */
+                    public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1alpha.RankingRecord;
+
+                    /**
+                     * Creates a plain object from a RankingRecord message. Also converts values to other types if specified.
+                     * @param message RankingRecord
+                     * @param [options] Conversion options
+                     * @returns Plain object
+                     */
+                    public static toObject(message: google.cloud.discoveryengine.v1alpha.RankingRecord, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                    /**
+                     * Converts this RankingRecord to JSON.
+                     * @returns JSON object
+                     */
+                    public toJSON(): { [k: string]: any };
+
+                    /**
+                     * Gets the default type url for RankingRecord
+                     * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                     * @returns The default type url
+                     */
+                    public static getTypeUrl(typeUrlPrefix?: string): string;
+                }
+
+                /** Properties of a RankRequest. */
+                interface IRankRequest {
+
+                    /** RankRequest rankingConfig */
+                    rankingConfig?: (string|null);
+
+                    /** RankRequest model */
+                    model?: (string|null);
+
+                    /** RankRequest topN */
+                    topN?: (number|null);
+
+                    /** RankRequest query */
+                    query?: (string|null);
+
+                    /** RankRequest records */
+                    records?: (google.cloud.discoveryengine.v1alpha.IRankingRecord[]|null);
+
+                    /** RankRequest ignoreRecordDetailsInResponse */
+                    ignoreRecordDetailsInResponse?: (boolean|null);
+                }
+
+                /** Represents a RankRequest. */
+                class RankRequest implements IRankRequest {
+
+                    /**
+                     * Constructs a new RankRequest.
+                     * @param [properties] Properties to set
+                     */
+                    constructor(properties?: google.cloud.discoveryengine.v1alpha.IRankRequest);
+
+                    /** RankRequest rankingConfig. */
+                    public rankingConfig: string;
+
+                    /** RankRequest model. */
+                    public model: string;
+
+                    /** RankRequest topN. */
+                    public topN: number;
+
+                    /** RankRequest query. */
+                    public query: string;
+
+                    /** RankRequest records. */
+                    public records: google.cloud.discoveryengine.v1alpha.IRankingRecord[];
+
+                    /** RankRequest ignoreRecordDetailsInResponse. */
+                    public ignoreRecordDetailsInResponse: boolean;
+
+                    /**
+                     * Creates a new RankRequest instance using the specified properties.
+                     * @param [properties] Properties to set
+                     * @returns RankRequest instance
+                     */
+                    public static create(properties?: google.cloud.discoveryengine.v1alpha.IRankRequest): google.cloud.discoveryengine.v1alpha.RankRequest;
+
+                    /**
+                     * Encodes the specified RankRequest message. Does not implicitly {@link google.cloud.discoveryengine.v1alpha.RankRequest.verify|verify} messages.
+                     * @param message RankRequest message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encode(message: google.cloud.discoveryengine.v1alpha.IRankRequest, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Encodes the specified RankRequest message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1alpha.RankRequest.verify|verify} messages.
+                     * @param message RankRequest message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encodeDelimited(message: google.cloud.discoveryengine.v1alpha.IRankRequest, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Decodes a RankRequest message from the specified reader or buffer.
+                     * @param reader Reader or buffer to decode from
+                     * @param [length] Message length if known beforehand
+                     * @returns RankRequest
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1alpha.RankRequest;
+
+                    /**
+                     * Decodes a RankRequest message from the specified reader or buffer, length delimited.
+                     * @param reader Reader or buffer to decode from
+                     * @returns RankRequest
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1alpha.RankRequest;
+
+                    /**
+                     * Verifies a RankRequest message.
+                     * @param message Plain object to verify
+                     * @returns `null` if valid, otherwise the reason why it is not
+                     */
+                    public static verify(message: { [k: string]: any }): (string|null);
+
+                    /**
+                     * Creates a RankRequest message from a plain object. Also converts values to their respective internal types.
+                     * @param object Plain object
+                     * @returns RankRequest
+                     */
+                    public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1alpha.RankRequest;
+
+                    /**
+                     * Creates a plain object from a RankRequest message. Also converts values to other types if specified.
+                     * @param message RankRequest
+                     * @param [options] Conversion options
+                     * @returns Plain object
+                     */
+                    public static toObject(message: google.cloud.discoveryengine.v1alpha.RankRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                    /**
+                     * Converts this RankRequest to JSON.
+                     * @returns JSON object
+                     */
+                    public toJSON(): { [k: string]: any };
+
+                    /**
+                     * Gets the default type url for RankRequest
+                     * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                     * @returns The default type url
+                     */
+                    public static getTypeUrl(typeUrlPrefix?: string): string;
+                }
+
+                /** Properties of a RankResponse. */
+                interface IRankResponse {
+
+                    /** RankResponse records */
+                    records?: (google.cloud.discoveryengine.v1alpha.IRankingRecord[]|null);
+                }
+
+                /** Represents a RankResponse. */
+                class RankResponse implements IRankResponse {
+
+                    /**
+                     * Constructs a new RankResponse.
+                     * @param [properties] Properties to set
+                     */
+                    constructor(properties?: google.cloud.discoveryengine.v1alpha.IRankResponse);
+
+                    /** RankResponse records. */
+                    public records: google.cloud.discoveryengine.v1alpha.IRankingRecord[];
+
+                    /**
+                     * Creates a new RankResponse instance using the specified properties.
+                     * @param [properties] Properties to set
+                     * @returns RankResponse instance
+                     */
+                    public static create(properties?: google.cloud.discoveryengine.v1alpha.IRankResponse): google.cloud.discoveryengine.v1alpha.RankResponse;
+
+                    /**
+                     * Encodes the specified RankResponse message. Does not implicitly {@link google.cloud.discoveryengine.v1alpha.RankResponse.verify|verify} messages.
+                     * @param message RankResponse message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encode(message: google.cloud.discoveryengine.v1alpha.IRankResponse, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Encodes the specified RankResponse message, length delimited. Does not implicitly {@link google.cloud.discoveryengine.v1alpha.RankResponse.verify|verify} messages.
+                     * @param message RankResponse message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encodeDelimited(message: google.cloud.discoveryengine.v1alpha.IRankResponse, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Decodes a RankResponse message from the specified reader or buffer.
+                     * @param reader Reader or buffer to decode from
+                     * @param [length] Message length if known beforehand
+                     * @returns RankResponse
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.discoveryengine.v1alpha.RankResponse;
+
+                    /**
+                     * Decodes a RankResponse message from the specified reader or buffer, length delimited.
+                     * @param reader Reader or buffer to decode from
+                     * @returns RankResponse
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.discoveryengine.v1alpha.RankResponse;
+
+                    /**
+                     * Verifies a RankResponse message.
+                     * @param message Plain object to verify
+                     * @returns `null` if valid, otherwise the reason why it is not
+                     */
+                    public static verify(message: { [k: string]: any }): (string|null);
+
+                    /**
+                     * Creates a RankResponse message from a plain object. Also converts values to their respective internal types.
+                     * @param object Plain object
+                     * @returns RankResponse
+                     */
+                    public static fromObject(object: { [k: string]: any }): google.cloud.discoveryengine.v1alpha.RankResponse;
+
+                    /**
+                     * Creates a plain object from a RankResponse message. Also converts values to other types if specified.
+                     * @param message RankResponse
+                     * @param [options] Conversion options
+                     * @returns Plain object
+                     */
+                    public static toObject(message: google.cloud.discoveryengine.v1alpha.RankResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                    /**
+                     * Converts this RankResponse to JSON.
+                     * @returns JSON object
+                     */
+                    public toJSON(): { [k: string]: any };
+
+                    /**
+                     * Gets the default type url for RankResponse
+                     * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                     * @returns The default type url
+                     */
+                    public static getTypeUrl(typeUrlPrefix?: string): string;
+                }
             }
 
             /** Namespace v1beta. */