Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage

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

Overview

The prompt message that aligns with the prompt message in google.cloud. aiplatform.master.GenerateContentRequest.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage

Returns a new instance of GoogleCloudAiplatformV1SchemaPromptSpecPromptMessage.



27491
27492
27493
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27491

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

Instance Attribute Details

#contents ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content>

The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request. Corresponds to the JSON property contents

Returns:



27452
27453
27454
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27452

def contents
  @contents
end

#generation_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfig

Generation config. Corresponds to the JSON property generationConfig

Returns:



27457
27458
27459
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27457

def generation_config
  @generation_config
end

#model ⇒ String

The model name. Corresponds to the JSON property model

Returns:

  • (String) 


27462
27463
27464
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27462

def model
  @model
end

#safety_settings ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SafetySetting>

Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. Corresponds to the JSON property safetySettings

Returns:



27468
27469
27470
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27468

def safety_settings
  @safety_settings
end

#system_instruction ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content

The base structured datatype containing multi-part content of a message. A Content includes a role field designating the producer of the Content and a parts field containing multi-part data that contains the content of the message turn. Corresponds to the JSON property systemInstruction

Returns:



27476
27477
27478
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27476

def system_instruction
  @system_instruction
end

#tool_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ToolConfig

Tool config. This config is shared for all tools provided in the request. Corresponds to the JSON property toolConfig

Returns:



27481
27482
27483
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27481

def tool_config
  @tool_config
end

#tools ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Tool>

A list of Tools the model may use to generate the next response. A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. Corresponds to the JSON property tools

Returns:



27489
27490
27491
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27489

def tools
  @tools
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



27496
27497
27498
27499
27500
27501
27502
27503
27504
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27496

def update!(**args)
  @contents = args[:contents] if args.key?(:contents)
  @generation_config = args[:generation_config] if args.key?(:generation_config)
  @model = args[:model] if args.key?(:model)
  @safety_settings = args[:safety_settings] if args.key?(:safety_settings)
  @system_instruction = args[:system_instruction] if args.key?(:system_instruction)
  @tool_config = args[:tool_config] if args.key?(:tool_config)
  @tools = args[:tools] if args.key?(:tools)
end