@google-cloud/discoveryengine 2.5.1 → 2.5.2

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.
@@ -19,6 +19,7 @@ package google.cloud.discoveryengine.v1;
19
19
  import "google/api/field_behavior.proto";
20
20
  import "google/api/resource.proto";
21
21
  import "google/cloud/discoveryengine/v1/answer.proto";
22
+ import "google/cloud/discoveryengine/v1/assist_answer.proto";
22
23
  import "google/protobuf/timestamp.proto";
23
24
 
24
25
  option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1";
@@ -67,6 +68,15 @@ message Session {
67
68
  // session.
68
69
  Answer detailed_answer = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
69
70
 
71
+ // Output only. In
72
+ // [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1.ConversationalSearchService.GetSession]
73
+ // API, if
74
+ // [GetSessionRequest.include_answer_details][google.cloud.discoveryengine.v1.GetSessionRequest.include_answer_details]
75
+ // is set to true, this field will be populated when getting assistant
76
+ // session.
77
+ AssistAnswer detailed_assist_answer = 8
78
+ [(google.api.field_behavior) = OUTPUT_ONLY];
79
+
70
80
  // Optional. Represents metadata related to the query config, for example
71
81
  // LLM model and version used, model parameters (temperature, grounding
72
82
  // parameters, etc.). The prefix "google." is reserved for Google-developed
@@ -103,6 +113,10 @@ message Session {
103
113
  // Turns.
104
114
  repeated Turn turns = 4;
105
115
 
116
+ // Optional. The labels for the session.
117
+ // Can be set as filter in ListSessionsRequest.
118
+ repeated string labels = 9 [(google.api.field_behavior) = OPTIONAL];
119
+
106
120
  // Output only. The time the session started.
107
121
  google.protobuf.Timestamp start_time = 5
108
122
  [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -11592,6 +11592,9 @@ export namespace google {
11592
11592
  /** Session turns */
11593
11593
  turns?: (google.cloud.discoveryengine.v1.Session.ITurn[]|null);
11594
11594
 
11595
+ /** Session labels */
11596
+ labels?: (string[]|null);
11597
+
11595
11598
  /** Session startTime */
11596
11599
  startTime?: (google.protobuf.ITimestamp|null);
11597
11600
 
@@ -11626,6 +11629,9 @@ export namespace google {
11626
11629
  /** Session turns. */
11627
11630
  public turns: google.cloud.discoveryengine.v1.Session.ITurn[];
11628
11631
 
11632
+ /** Session labels. */
11633
+ public labels: string[];
11634
+
11629
11635
  /** Session startTime. */
11630
11636
  public startTime?: (google.protobuf.ITimestamp|null);
11631
11637
 
@@ -11727,6 +11733,9 @@ export namespace google {
11727
11733
  /** Turn detailedAnswer */
11728
11734
  detailedAnswer?: (google.cloud.discoveryengine.v1.IAnswer|null);
11729
11735
 
11736
+ /** Turn detailedAssistAnswer */
11737
+ detailedAssistAnswer?: (google.cloud.discoveryengine.v1.IAssistAnswer|null);
11738
+
11730
11739
  /** Turn queryConfig */
11731
11740
  queryConfig?: ({ [k: string]: string }|null);
11732
11741
  }
@@ -11749,6 +11758,9 @@ export namespace google {
11749
11758
  /** Turn detailedAnswer. */
11750
11759
  public detailedAnswer?: (google.cloud.discoveryengine.v1.IAnswer|null);
11751
11760
 
11761
+ /** Turn detailedAssistAnswer. */
11762
+ public detailedAssistAnswer?: (google.cloud.discoveryengine.v1.IAssistAnswer|null);
11763
+
11752
11764
  /** Turn queryConfig. */
11753
11765
  public queryConfig: { [k: string]: string };
11754
11766
 
@@ -29669,6 +29669,7 @@
29669
29669
  * @property {google.cloud.discoveryengine.v1.Session.State|null} [state] Session state
29670
29670
  * @property {string|null} [userPseudoId] Session userPseudoId
29671
29671
  * @property {Array.<google.cloud.discoveryengine.v1.Session.ITurn>|null} [turns] Session turns
29672
+ * @property {Array.<string>|null} [labels] Session labels
29672
29673
  * @property {google.protobuf.ITimestamp|null} [startTime] Session startTime
29673
29674
  * @property {google.protobuf.ITimestamp|null} [endTime] Session endTime
29674
29675
  * @property {boolean|null} [isPinned] Session isPinned
@@ -29684,6 +29685,7 @@
29684
29685
  */
29685
29686
  function Session(properties) {
29686
29687
  this.turns = [];
29688
+ this.labels = [];
29687
29689
  if (properties)
29688
29690
  for (var keys = Object.keys(properties), i = 0; i < keys.length; ++i)
29689
29691
  if (properties[keys[i]] != null)
@@ -29730,6 +29732,14 @@
29730
29732
  */
29731
29733
  Session.prototype.turns = $util.emptyArray;
29732
29734
 
29735
+ /**
29736
+ * Session labels.
29737
+ * @member {Array.<string>} labels
29738
+ * @memberof google.cloud.discoveryengine.v1.Session
29739
+ * @instance
29740
+ */
29741
+ Session.prototype.labels = $util.emptyArray;
29742
+
29733
29743
  /**
29734
29744
  * Session startTime.
29735
29745
  * @member {google.protobuf.ITimestamp|null|undefined} startTime
@@ -29795,6 +29805,9 @@
29795
29805
  writer.uint32(/* id 7, wireType 2 =*/58).string(message.displayName);
29796
29806
  if (message.isPinned != null && Object.hasOwnProperty.call(message, "isPinned"))
29797
29807
  writer.uint32(/* id 8, wireType 0 =*/64).bool(message.isPinned);
29808
+ if (message.labels != null && message.labels.length)
29809
+ for (var i = 0; i < message.labels.length; ++i)
29810
+ writer.uint32(/* id 9, wireType 2 =*/74).string(message.labels[i]);
29798
29811
  return writer;
29799
29812
  };
29800
29813
 
@@ -29853,6 +29866,12 @@
29853
29866
  message.turns.push($root.google.cloud.discoveryengine.v1.Session.Turn.decode(reader, reader.uint32()));
29854
29867
  break;
29855
29868
  }
29869
+ case 9: {
29870
+ if (!(message.labels && message.labels.length))
29871
+ message.labels = [];
29872
+ message.labels.push(reader.string());
29873
+ break;
29874
+ }
29856
29875
  case 5: {
29857
29876
  message.startTime = $root.google.protobuf.Timestamp.decode(reader, reader.uint32());
29858
29877
  break;
@@ -29926,6 +29945,13 @@
29926
29945
  return "turns." + error;
29927
29946
  }
29928
29947
  }
29948
+ if (message.labels != null && message.hasOwnProperty("labels")) {
29949
+ if (!Array.isArray(message.labels))
29950
+ return "labels: array expected";
29951
+ for (var i = 0; i < message.labels.length; ++i)
29952
+ if (!$util.isString(message.labels[i]))
29953
+ return "labels: string[] expected";
29954
+ }
29929
29955
  if (message.startTime != null && message.hasOwnProperty("startTime")) {
29930
29956
  var error = $root.google.protobuf.Timestamp.verify(message.startTime);
29931
29957
  if (error)
@@ -29986,6 +30012,13 @@
29986
30012
  message.turns[i] = $root.google.cloud.discoveryengine.v1.Session.Turn.fromObject(object.turns[i]);
29987
30013
  }
29988
30014
  }
30015
+ if (object.labels) {
30016
+ if (!Array.isArray(object.labels))
30017
+ throw TypeError(".google.cloud.discoveryengine.v1.Session.labels: array expected");
30018
+ message.labels = [];
30019
+ for (var i = 0; i < object.labels.length; ++i)
30020
+ message.labels[i] = String(object.labels[i]);
30021
+ }
29989
30022
  if (object.startTime != null) {
29990
30023
  if (typeof object.startTime !== "object")
29991
30024
  throw TypeError(".google.cloud.discoveryengine.v1.Session.startTime: object expected");
@@ -30014,8 +30047,10 @@
30014
30047
  if (!options)
30015
30048
  options = {};
30016
30049
  var object = {};
30017
- if (options.arrays || options.defaults)
30050
+ if (options.arrays || options.defaults) {
30018
30051
  object.turns = [];
30052
+ object.labels = [];
30053
+ }
30019
30054
  if (options.defaults) {
30020
30055
  object.name = "";
30021
30056
  object.state = options.enums === String ? "STATE_UNSPECIFIED" : 0;
@@ -30044,6 +30079,11 @@
30044
30079
  object.displayName = message.displayName;
30045
30080
  if (message.isPinned != null && message.hasOwnProperty("isPinned"))
30046
30081
  object.isPinned = message.isPinned;
30082
+ if (message.labels && message.labels.length) {
30083
+ object.labels = [];
30084
+ for (var j = 0; j < message.labels.length; ++j)
30085
+ object.labels[j] = message.labels[j];
30086
+ }
30047
30087
  return object;
30048
30088
  };
30049
30089
 
@@ -30082,6 +30122,7 @@
30082
30122
  * @property {google.cloud.discoveryengine.v1.IQuery|null} [query] Turn query
30083
30123
  * @property {string|null} [answer] Turn answer
30084
30124
  * @property {google.cloud.discoveryengine.v1.IAnswer|null} [detailedAnswer] Turn detailedAnswer
30125
+ * @property {google.cloud.discoveryengine.v1.IAssistAnswer|null} [detailedAssistAnswer] Turn detailedAssistAnswer
30085
30126
  * @property {Object.<string,string>|null} [queryConfig] Turn queryConfig
30086
30127
  */
30087
30128
 
@@ -30125,6 +30166,14 @@
30125
30166
  */
30126
30167
  Turn.prototype.detailedAnswer = null;
30127
30168
 
30169
+ /**
30170
+ * Turn detailedAssistAnswer.
30171
+ * @member {google.cloud.discoveryengine.v1.IAssistAnswer|null|undefined} detailedAssistAnswer
30172
+ * @memberof google.cloud.discoveryengine.v1.Session.Turn
30173
+ * @instance
30174
+ */
30175
+ Turn.prototype.detailedAssistAnswer = null;
30176
+
30128
30177
  /**
30129
30178
  * Turn queryConfig.
30130
30179
  * @member {Object.<string,string>} queryConfig
@@ -30163,6 +30212,8 @@
30163
30212
  writer.uint32(/* id 2, wireType 2 =*/18).string(message.answer);
30164
30213
  if (message.detailedAnswer != null && Object.hasOwnProperty.call(message, "detailedAnswer"))
30165
30214
  $root.google.cloud.discoveryengine.v1.Answer.encode(message.detailedAnswer, writer.uint32(/* id 7, wireType 2 =*/58).fork()).ldelim();
30215
+ if (message.detailedAssistAnswer != null && Object.hasOwnProperty.call(message, "detailedAssistAnswer"))
30216
+ $root.google.cloud.discoveryengine.v1.AssistAnswer.encode(message.detailedAssistAnswer, writer.uint32(/* id 8, wireType 2 =*/66).fork()).ldelim();
30166
30217
  if (message.queryConfig != null && Object.hasOwnProperty.call(message, "queryConfig"))
30167
30218
  for (var keys = Object.keys(message.queryConfig), i = 0; i < keys.length; ++i)
30168
30219
  writer.uint32(/* id 16, wireType 2 =*/130).fork().uint32(/* id 1, wireType 2 =*/10).string(keys[i]).uint32(/* id 2, wireType 2 =*/18).string(message.queryConfig[keys[i]]).ldelim();
@@ -30214,6 +30265,10 @@
30214
30265
  message.detailedAnswer = $root.google.cloud.discoveryengine.v1.Answer.decode(reader, reader.uint32());
30215
30266
  break;
30216
30267
  }
30268
+ case 8: {
30269
+ message.detailedAssistAnswer = $root.google.cloud.discoveryengine.v1.AssistAnswer.decode(reader, reader.uint32());
30270
+ break;
30271
+ }
30217
30272
  case 16: {
30218
30273
  if (message.queryConfig === $util.emptyObject)
30219
30274
  message.queryConfig = {};
@@ -30285,6 +30340,11 @@
30285
30340
  if (error)
30286
30341
  return "detailedAnswer." + error;
30287
30342
  }
30343
+ if (message.detailedAssistAnswer != null && message.hasOwnProperty("detailedAssistAnswer")) {
30344
+ var error = $root.google.cloud.discoveryengine.v1.AssistAnswer.verify(message.detailedAssistAnswer);
30345
+ if (error)
30346
+ return "detailedAssistAnswer." + error;
30347
+ }
30288
30348
  if (message.queryConfig != null && message.hasOwnProperty("queryConfig")) {
30289
30349
  if (!$util.isObject(message.queryConfig))
30290
30350
  return "queryConfig: object expected";
@@ -30320,6 +30380,11 @@
30320
30380
  throw TypeError(".google.cloud.discoveryengine.v1.Session.Turn.detailedAnswer: object expected");
30321
30381
  message.detailedAnswer = $root.google.cloud.discoveryengine.v1.Answer.fromObject(object.detailedAnswer);
30322
30382
  }
30383
+ if (object.detailedAssistAnswer != null) {
30384
+ if (typeof object.detailedAssistAnswer !== "object")
30385
+ throw TypeError(".google.cloud.discoveryengine.v1.Session.Turn.detailedAssistAnswer: object expected");
30386
+ message.detailedAssistAnswer = $root.google.cloud.discoveryengine.v1.AssistAnswer.fromObject(object.detailedAssistAnswer);
30387
+ }
30323
30388
  if (object.queryConfig) {
30324
30389
  if (typeof object.queryConfig !== "object")
30325
30390
  throw TypeError(".google.cloud.discoveryengine.v1.Session.Turn.queryConfig: object expected");
@@ -30349,6 +30414,7 @@
30349
30414
  object.query = null;
30350
30415
  object.answer = "";
30351
30416
  object.detailedAnswer = null;
30417
+ object.detailedAssistAnswer = null;
30352
30418
  }
30353
30419
  if (message.query != null && message.hasOwnProperty("query"))
30354
30420
  object.query = $root.google.cloud.discoveryengine.v1.Query.toObject(message.query, options);
@@ -30356,6 +30422,8 @@
30356
30422
  object.answer = message.answer;
30357
30423
  if (message.detailedAnswer != null && message.hasOwnProperty("detailedAnswer"))
30358
30424
  object.detailedAnswer = $root.google.cloud.discoveryengine.v1.Answer.toObject(message.detailedAnswer, options);
30425
+ if (message.detailedAssistAnswer != null && message.hasOwnProperty("detailedAssistAnswer"))
30426
+ object.detailedAssistAnswer = $root.google.cloud.discoveryengine.v1.AssistAnswer.toObject(message.detailedAssistAnswer, options);
30359
30427
  var keys2;
30360
30428
  if (message.queryConfig && (keys2 = Object.keys(message.queryConfig)).length) {
30361
30429
  object.queryConfig = {};
@@ -2858,6 +2858,14 @@
2858
2858
  "type": "Turn",
2859
2859
  "id": 4
2860
2860
  },
2861
+ "labels": {
2862
+ "rule": "repeated",
2863
+ "type": "string",
2864
+ "id": 9,
2865
+ "options": {
2866
+ "(google.api.field_behavior)": "OPTIONAL"
2867
+ }
2868
+ },
2861
2869
  "startTime": {
2862
2870
  "type": "google.protobuf.Timestamp",
2863
2871
  "id": 5,
@@ -2905,6 +2913,13 @@
2905
2913
  "(google.api.field_behavior)": "OUTPUT_ONLY"
2906
2914
  }
2907
2915
  },
2916
+ "detailedAssistAnswer": {
2917
+ "type": "AssistAnswer",
2918
+ "id": 8,
2919
+ "options": {
2920
+ "(google.api.field_behavior)": "OUTPUT_ONLY"
2921
+ }
2922
+ },
2908
2923
  "queryConfig": {
2909
2924
  "keyType": "string",
2910
2925
  "type": "string",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@google-cloud/discoveryengine",
3
- "version": "2.5.1",
3
+ "version": "2.5.2",
4
4
  "description": "Discovery Engine API client for Node.js",
5
5
  "repository": {
6
6
  "type": "git",