Google Cloud Discovery Engine V1 Client - Class Feedback (1.17.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class Feedback.

Information about the user feedback. This information will be used for logging and metrics purpose.

Generated from protobuf message google.cloud.discoveryengine.v1.Feedback

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ feedback_type int

Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details.

↳ reasons int[]

Optional. The reason if user gives a thumb down.

↳ comment string

Optional. The additional user comment of the feedback if user gives a thumb down.

↳ conversation_info Feedback\ConversationInfo

The related conversation information when user gives feedback.

↳ llm_model_version string

The version of the LLM model that was used to generate the response.

↳ feedback_source int

Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP.

↳ component_version string

Optional. The version of the component that this report is being sent from.

↳ data_terms_accepted bool

Optional. Whether the customer accepted data use terms.

getFeedbackType

Required. Indicate whether the user gives a positive or negative feedback.

If the user gives a negative feedback, there might be more feedback details.

Returns
Type Description
int Enum of type FeedbackType.

setFeedbackType

Required. Indicate whether the user gives a positive or negative feedback.

If the user gives a negative feedback, there might be more feedback details.

Parameter
Name Description
var int

Enum of type FeedbackType.

Returns
Type Description
$this

getReasons

Optional. The reason if user gives a thumb down.

Returns
Type Description
Google\Protobuf\RepeatedField<int>

setReasons

Optional. The reason if user gives a thumb down.

Parameter
Name Description
var int[]
Returns
Type Description
$this

getComment

Optional. The additional user comment of the feedback if user gives a thumb down.

Returns
Type Description
string

setComment

Optional. The additional user comment of the feedback if user gives a thumb down.

Parameter
Name Description
var string
Returns
Type Description
$this

getConversationInfo

The related conversation information when user gives feedback.

Returns
Type Description
Feedback\ConversationInfo|null

hasConversationInfo

clearConversationInfo

setConversationInfo

The related conversation information when user gives feedback.

Parameter
Name Description
var Feedback\ConversationInfo
Returns
Type Description
$this

getLlmModelVersion

The version of the LLM model that was used to generate the response.

Returns
Type Description
string

setLlmModelVersion

The version of the LLM model that was used to generate the response.

Parameter
Name Description
var string
Returns
Type Description
$this

getFeedbackSource

Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP.

Returns
Type Description
int Enum of type FeedbackSource.

setFeedbackSource

Optional. The UI component the user feedback comes from, which could be GOOGLE_CONSOLE, GOOGLE_WIDGET, GOOGLE_WEBAPP.

Parameter
Name Description
var int

Enum of type FeedbackSource.

Returns
Type Description
$this

getComponentVersion

Optional. The version of the component that this report is being sent from.

Returns
Type Description
string

setComponentVersion

Optional. The version of the component that this report is being sent from.

Parameter
Name Description
var string
Returns
Type Description
$this

getDataTermsAccepted

Optional. Whether the customer accepted data use terms.

Returns
Type Description
bool

setDataTermsAccepted

Optional. Whether the customer accepted data use terms.

Parameter
Name Description
var bool
Returns
Type Description
$this