Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationPrompt

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

Overview

Prompt to be evaluated. This can represent a single-turn prompt or a multi- turn conversation for agent evaluations.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1EvaluationPrompt

Returns a new instance of GoogleCloudAiplatformV1beta1EvaluationPrompt.



18995
18996
18997
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18995

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

Instance Attribute Details

#agent_data ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1AgentData

Represents data specific to multi-turn agent evaluations. Corresponds to the JSON property agentData

Returns:



18973
18974
18975
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18973

def agent_data
  @agent_data
end

#prompt_template_data ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationPromptPromptTemplateData

Message to hold a prompt template and the values to populate the template. Corresponds to the JSON property promptTemplateData

Returns:



18978
18979
18980
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18978

def prompt_template_data
  @prompt_template_data
end

#text ⇒ String

Text prompt. Corresponds to the JSON property text

Returns:

  • (String) 


18983
18984
18985
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18983

def text
  @text
end

#user_scenario ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationPromptUserScenario

User scenario to help simulate multi-turn agent running results. Corresponds to the JSON property userScenario

Returns:



18988
18989
18990
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18988

def user_scenario
  @user_scenario
end

#value ⇒ Object

Fields and values that can be used to populate the prompt template. Corresponds to the JSON property value

Returns:

  • (Object) 


18993
18994
18995
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18993

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



19000
19001
19002
19003
19004
19005
19006
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 19000

def update!(**args)
  @agent_data = args[:agent_data] if args.key?(:agent_data)
  @prompt_template_data = args[:prompt_template_data] if args.key?(:prompt_template_data)
  @text = args[:text] if args.key?(:text)
  @user_scenario = args[:user_scenario] if args.key?(:user_scenario)
  @value = args[:value] if args.key?(:value)
end