Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateContentRequest

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

Request message for [PredictionService.GenerateContent].

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1GenerateContentRequest

Returns a new instance of GoogleCloudAiplatformV1GenerateContentRequest.



10469
10470
10471
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10469

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

Instance Attribute Details

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

Required. 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:



10426
10427
10428
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10426

def contents
  @contents
end

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

Generation config. Corresponds to the JSON property generationConfig

Returns:



10431
10432
10433
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10431

def generation_config
  @generation_config
end

#labels ⇒ Hash<String,String>

Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


10440
10441
10442
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10440

def labels
  @labels
end

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

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

Returns:



10446
10447
10448
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10446

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:



10454
10455
10456
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10454

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:



10459
10460
10461
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10459

def tool_config
  @tool_config
end

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

Optional. 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:



10467
10468
10469
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10467

def tools
  @tools
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10474
10475
10476
10477
10478
10479
10480
10481
10482
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10474

def update!(**args)
  @contents = args[:contents] if args.key?(:contents)
  @generation_config = args[:generation_config] if args.key?(:generation_config)
  @labels = args[:labels] if args.key?(:labels)
  @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