Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Feedback

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1Feedback

Returns a new instance of GoogleCloudDiscoveryengineV1Feedback.



4941
4942
4943
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4941

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#comment ⇒ String

Optional. The additional user comment of the feedback if user gives a thumb down. Corresponds to the JSON property comment

Returns:

  • (String) 


4918
4919
4920
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4918

def comment
  @comment
end

#conversation_info ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FeedbackConversationInfo

The conversation information such as the question index and session name. Corresponds to the JSON property conversationInfo

Returns:



4923
4924
4925
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4923

def conversation_info
  @conversation_info
end

#feedback_type ⇒ 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. Corresponds to the JSON property feedbackType

Returns:

  • (String) 


4929
4930
4931
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4929

def feedback_type
  @feedback_type
end

#llm_model_version ⇒ String

The version of the LLM model that was used to generate the response. Corresponds to the JSON property llmModelVersion

Returns:

  • (String) 


4934
4935
4936
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4934

def llm_model_version
  @llm_model_version
end

#reasons ⇒ Array<String>

Optional. The reason if user gives a thumb down. Corresponds to the JSON property reasons

Returns:

  • (Array<String>) 


4939
4940
4941
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4939

def reasons
  @reasons
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4946
4947
4948
4949
4950
4951
4952
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4946

def update!(**args)
  @comment = args[:comment] if args.key?(:comment)
  @conversation_info = args[:conversation_info] if args.key?(:conversation_info)
  @feedback_type = args[:feedback_type] if args.key?(:feedback_type)
  @llm_model_version = args[:llm_model_version] if args.key?(:llm_model_version)
  @reasons = args[:reasons] if args.key?(:reasons)
end