@google-cloud/discoveryengine 2.2.0 → 2.4.0

package/build/protos/google/cloud/discoveryengine/v1/user_license.proto

@@ -0,0 +1,98 @@
+// Copyright 2025 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.v1;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "UserLicenseProto";
+option java_package = "com.google.cloud.discoveryengine.v1";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1";
+
+// User License information assigned by the admin.
+message UserLicense {
+  // License assignment state enumeration.
+  enum LicenseAssignmentState {
+    // Default value.
+    LICENSE_ASSIGNMENT_STATE_UNSPECIFIED = 0;
+
+    // License assigned to the user.
+    ASSIGNED = 1;
+
+    // No license assigned to the user.
+    // Deprecated, translated to NO_LICENSE.
+    UNASSIGNED = 2;
+
+    // No license assigned to the user.
+    NO_LICENSE = 3;
+
+    // User attempted to login but no license assigned to the user.
+    // This state is only used for no user first time login attempt but cannot
+    // get license assigned.
+    // Users already logged in but cannot get license assigned will be assigned
+    // NO_LICENSE state(License could be unassigned by admin).
+    NO_LICENSE_ATTEMPTED_LOGIN = 4;
+  }
+
+  // Required. Immutable. The user principal of the User, could be email address
+  // or other prinical identifier. This field is immutable. Admin assign
+  // licenses based on the user principal.
+  string user_principal = 1 [
+    (google.api.field_behavior) = IMMUTABLE,
+    (google.api.field_behavior) = REQUIRED
+  ];
+
+  // Optional. The user profile.
+  // We user user full name(First name + Last name) as user profile.
+  string user_profile = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. License assignment state of the user.
+  // If the user is assigned with a license config, the user loggin will be
+  // assigned with the license;
+  // If the user's license assignment state is unassigned or unspecified, no
+  // license config will be associated to the user;
+  LicenseAssignmentState license_assignment_state = 4
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Optional. The full resource name of the Subscription(LicenseConfig)
+  // assigned to the user.
+  string license_config = 5 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/LicenseConfig"
+    }
+  ];
+
+  // Output only. User created timestamp.
+  google.protobuf.Timestamp create_time = 6
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. User update timestamp.
+  google.protobuf.Timestamp update_time = 7
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. User last logged in time.
+  // If the user has not logged in yet, this field will be empty.
+  google.protobuf.Timestamp last_login_time = 8
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}

package/build/protos/google/cloud/discoveryengine/v1/user_license_service.proto

@@ -0,0 +1,191 @@
+// Copyright 2025 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.v1;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/cloud/discoveryengine/v1/user_license.proto";
+import "google/longrunning/operations.proto";
+import "google/protobuf/field_mask.proto";
+import "google/protobuf/timestamp.proto";
+import "google/rpc/status.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "UserLicenseServiceProto";
+option java_package = "com.google.cloud.discoveryengine.v1";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1";
+
+// Service for managing User Licenses.
+service UserLicenseService {
+  option (google.api.default_host) = "discoveryengine.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Lists the User Licenses.
+  rpc ListUserLicenses(ListUserLicensesRequest)
+      returns (ListUserLicensesResponse) {
+    option (google.api.http) = {
+      get: "/v1/{parent=projects/*/locations/*/userStores/*}/userLicenses"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+
+  // Updates the User License.
+  // This method is used for batch assign/unassign licenses to users.
+  rpc BatchUpdateUserLicenses(BatchUpdateUserLicensesRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1/{parent=projects/*/locations/*/userStores/*}:batchUpdateUserLicenses"
+      body: "*"
+    };
+    option (google.longrunning.operation_info) = {
+      response_type: "google.cloud.discoveryengine.v1.BatchUpdateUserLicensesResponse"
+      metadata_type: "google.cloud.discoveryengine.v1.BatchUpdateUserLicensesMetadata"
+    };
+  }
+}
+
+// Request message for
+// [UserLicenseService.ListUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.ListUserLicenses].
+message ListUserLicensesRequest {
+  // Required. The parent [UserStore][] resource name, format:
+  // `projects/{project}/locations/{location}/userStores/{user_store_id}`.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/UserStore"
+    }
+  ];
+
+  // Optional. Requested page size. Server may return fewer items than
+  // requested. If unspecified, defaults to 10. The maximum value is 50; values
+  // above 50 will be coerced to 50.
+  //
+  // If this field is negative, an INVALID_ARGUMENT error is returned.
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. A page token, received from a previous `ListUserLicenses` call.
+  // Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to `ListUserLicenses`
+  // must match the call that provided the page token.
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Filter for the list request.
+  //
+  // Supported fields:
+  //
+  // * `license_assignment_state`
+  //
+  // Examples:
+  //
+  // * `license_assignment_state = ASSIGNED` to list assigned user licenses.
+  // * `license_assignment_state = NO_LICENSE` to list not licensed users.
+  // * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users
+  // who attempted login but no license assigned.
+  // * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter
+  // out users who attempted login but no license assigned.
+  string filter = 4 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Response message for
+// [UserLicenseService.ListUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.ListUserLicenses].
+message ListUserLicensesResponse {
+  // All the customer's
+  // [UserLicense][google.cloud.discoveryengine.v1.UserLicense]s.
+  repeated UserLicense user_licenses = 1;
+
+  // A token, which can be sent as `page_token` to retrieve the next page. If
+  // this field is omitted, there are no subsequent pages.
+  string next_page_token = 2;
+}
+
+// Request message for
+// [UserLicenseService.BatchUpdateUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.BatchUpdateUserLicenses]
+// method.
+message BatchUpdateUserLicensesRequest {
+  // The inline source for the input config for BatchUpdateUserLicenses
+  // method.
+  message InlineSource {
+    // Required. A list of user licenses to update. Each user license
+    // must have a valid
+    // [UserLicense.user_principal][google.cloud.discoveryengine.v1.UserLicense.user_principal].
+    repeated UserLicense user_licenses = 1
+        [(google.api.field_behavior) = REQUIRED];
+
+    // Optional. The list of fields to update.
+    google.protobuf.FieldMask update_mask = 2
+        [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Required. The source of the input.
+  oneof source {
+    // The inline source for the input content for document embeddings.
+    InlineSource inline_source = 2;
+  }
+
+  // Required. The parent [UserStore][] resource name, format:
+  // `projects/{project}/locations/{location}/userStores/{user_store_id}`.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/UserStore"
+    }
+  ];
+
+  // Optional. If true, if user licenses removed associated license config, the
+  // user license will be deleted. By default which is false, the user license
+  // will be updated to unassigned state.
+  bool delete_unassigned_user_licenses = 4
+      [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Metadata related to the progress of the
+// [UserLicenseService.BatchUpdateUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.BatchUpdateUserLicenses]
+// operation. This will be returned by the google.longrunning.Operation.metadata
+// field.
+message BatchUpdateUserLicensesMetadata {
+  // Operation create time.
+  google.protobuf.Timestamp create_time = 1;
+
+  // Operation last update time. If the operation is done, this is also the
+  // finish time.
+  google.protobuf.Timestamp update_time = 2;
+
+  // Count of user licenses successfully updated.
+  int64 success_count = 3;
+
+  // Count of user licenses that failed to be updated.
+  int64 failure_count = 4;
+}
+
+// Response message for
+// [UserLicenseService.BatchUpdateUserLicenses][google.cloud.discoveryengine.v1.UserLicenseService.BatchUpdateUserLicenses]
+// method.
+message BatchUpdateUserLicensesResponse {
+  // UserLicenses successfully updated.
+  repeated UserLicense user_licenses = 1;
+
+  // A sample of errors encountered while processing the request.
+  repeated google.rpc.Status error_samples = 2;
+}

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

@@ -127,6 +127,21 @@ enum SearchAddOn {
   SEARCH_ADD_ON_LLM = 1;
 }
 
+// The origin of the file.
+enum FileOriginType {
+  // Default value.
+  FILE_ORIGIN_TYPE_UNSPECIFIED = 0;
+
+  // The file was provided by the user.
+  USER_PROVIDED = 1;
+
+  // The file was generated by an AI model.
+  AI_GENERATED = 2;
+
+  // The file was generated from other files by an internal process.
+  INTERNALLY_GENERATED = 3;
+}
+
 // A floating point interval.
 message Interval {
   // The lower bound of the interval. If neither of the min fields are

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

@@ -859,7 +859,7 @@ message GetAnswerRequest {
 // Request for CreateSession method.
 message CreateSessionRequest {
   // Required. Full resource name of parent data store. Format:
-  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -889,7 +889,7 @@ message UpdateSessionRequest {
 // Request for DeleteSession method.
 message DeleteSessionRequest {
   // Required. The resource name of the Session to delete. Format:
-  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -901,19 +901,23 @@ message DeleteSessionRequest {
 // Request for GetSession method.
 message GetSessionRequest {
   // Required. The resource name of the Session to get. Format:
-  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
       type: "discoveryengine.googleapis.com/Session"
     }
   ];
+
+  // Optional. If set to true, the full session including all answer details
+  // will be returned.
+  bool include_answer_details = 2 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Request for ListSessions method.
 message ListSessionsRequest {
   // Required. The data store resource name. Format:
-  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -929,23 +933,40 @@ message ListSessionsRequest {
   // Provide this to retrieve the subsequent page.
   string page_token = 3;
 
-  // A filter to apply on the list results. The supported features are:
-  // user_pseudo_id, state.
+  // A comma-separated list of fields to filter by, in EBNF grammar.
+  // The supported fields are:
+  // * `user_pseudo_id`
+  // * `state`
+  // * `display_name`
+  // * `starred`
+  // * `is_pinned`
+  // * `labels`
+  // * `create_time`
+  // * `update_time`
   //
-  // Example:
+  // Examples:
   // "user_pseudo_id = some_id"
+  // "display_name = \"some_name\""
+  // "starred = true"
+  // "is_pinned=true AND (NOT labels:hidden)"
+  // "create_time > \"1970-01-01T12:00:00Z\""
   string filter = 4;
 
   // A comma-separated list of fields to order by, sorted in ascending order.
   // Use "desc" after a field name for descending.
   // Supported fields:
+  //
   //   * `update_time`
   //   * `create_time`
   //   * `session_name`
+  //   * `is_pinned`
   //
   // Example:
-  // "update_time desc"
-  // "create_time"
+  //
+  // * "update_time desc"
+  // * "create_time"
+  // * "is_pinned desc,update_time desc": list sessions by is_pinned first, then
+  //    by update_time.
   string order_by = 5;
 }
 

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

@@ -1035,22 +1035,16 @@ message SearchRequest {
   // between /search API calls and /answer API calls.
   //
   // Example #1 (multi-turn /search API calls):
-  //   1. Call /search API with the auto-session mode (see below).
-  //   2. Call /search API with the session ID generated in the first call.
-  //      Here, the previous search query gets considered in query
-  //      standing. I.e., if the first query is "How did Alphabet do in 2022?"
-  //      and the current query is "How about 2023?", the current query will
-  //      be interpreted as "How did Alphabet do in 2023?".
+  //   Call /search API with the session ID generated in the first call.
+  //   Here, the previous search query gets considered in query
+  //   standing. I.e., if the first query is "How did Alphabet do in 2022?"
+  //   and the current query is "How about 2023?", the current query will
+  //   be interpreted as "How did Alphabet do in 2023?".
   //
   // Example #2 (coordination between /search API calls and /answer API calls):
-  //   1. Call /search API with the auto-session mode (see below).
-  //   2. Call /answer API with the session ID generated in the first call.
-  //      Here, the answer generation happens in the context of the search
-  //      results from the first search call.
-  //
-  // Auto-session mode: when `projects/.../sessions/-` is used, a new session
-  // gets automatically created. Otherwise, users can use the create-session API
-  // to create a session manually.
+  //   Call /answer API with the session ID generated in the first call.
+  //   Here, the answer generation happens in the context of the search
+  //   results from the first search call.
   //
   // Multi-turn Search feature is currently at private GA stage. Please use
   // v1alpha or v1beta version instead before we launch this feature to public