You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html
+44Lines changed: 44 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -414,6 +414,18 @@ <h3>Method Details</h3>
414
414
"engine": "A String", # The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search.
415
415
"eventTime": "A String", # Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.
416
416
"eventType": "A String", # Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc.
417
+
"feedback": { # Information about the user feedback. This information will be used for logging and metrics purpose. # Optional. This field is optional except for the `add-feedback` event types.
418
+
"comment": "A String", # Optional. The additional user comment of the feedback if user gives a thumb down.
419
+
"conversationInfo": { # The conversation information such as the question index and session name. # The related conversation information when user gives feedback.
420
+
"questionIndex": 42, # The index of the user input within the conversation messages.
421
+
"session": "A String", # Name of the newly generated or continued session.
422
+
},
423
+
"feedbackType": "A String", # Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details.
424
+
"llmModelVersion": "A String", # The version of the LLM model that was used to generate the response.
425
+
"reasons": [ # Optional. The reason if user gives a thumb down.
426
+
"A String",
427
+
],
428
+
},
417
429
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
418
430
"mediaInfo": { # Media-specific user event information. # Media-specific info.
419
431
"mediaProgressDuration": "A String", # The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90.
@@ -427,10 +439,42 @@ <h3>Method Details</h3>
427
439
},
428
440
"panel": { # Detailed panel information associated with a user event. # Panel metadata associated with this user event.
429
441
"displayName": "A String", # The display name of the panel.
442
+
"documents": [ # Optional. The document IDs associated with this panel.
443
+
{ # Detailed document information associated with a user event.
444
+
"id": "A String", # The Document resource ID.
445
+
"joined": True or False, # Output only. Whether the referenced Document can be found in the data store.
446
+
"name": "A String", # The Document resource full name, of the form: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
447
+
"promotionIds": [ # The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
448
+
"A String",
449
+
],
450
+
"quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
451
+
"uri": "A String", # The Document URI - only allowed for website data stores.
452
+
},
453
+
],
430
454
"panelId": "A String", # Required. The panel ID.
431
455
"panelPosition": 42, # The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set.
432
456
"totalPanels": 42, # The total number of panels, including this one, shown to the user. Must be set if panel_position is set.
433
457
},
458
+
"panels": [ # Optional. List of panels associated with this event. Used for page-level impression data.
459
+
{ # Detailed panel information associated with a user event.
460
+
"displayName": "A String", # The display name of the panel.
461
+
"documents": [ # Optional. The document IDs associated with this panel.
462
+
{ # Detailed document information associated with a user event.
463
+
"id": "A String", # The Document resource ID.
464
+
"joined": True or False, # Output only. Whether the referenced Document can be found in the data store.
465
+
"name": "A String", # The Document resource full name, of the form: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
466
+
"promotionIds": [ # The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
467
+
"A String",
468
+
],
469
+
"quantity": 42, # Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`
470
+
"uri": "A String", # The Document URI - only allowed for website data stores.
471
+
},
472
+
],
473
+
"panelId": "A String", # Required. The panel ID.
474
+
"panelPosition": 42, # The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set.
475
+
"totalPanels": 42, # The total number of panels, including this one, shown to the user. Must be set if panel_position is set.
476
+
},
477
+
],
434
478
"promotionIds": [ # The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.
0 commit comments