Class: Google::Apis::FirebasemlV2beta::GenerateContentRequest

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

Overview

Request message for [PredictionService.GenerateContent].

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GenerateContentRequest

Returns a new instance of GenerateContentRequest.



527
528
529
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 527

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

Instance Attribute Details

#cached_content ⇒ String

Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: projects/project/locations/location/cachedContents/cachedContent Corresponds to the JSON property cachedContent

Returns:

  • (String) 


486
487
488
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 486

def cached_content
  @cached_content
end

#contents ⇒ Array<Google::Apis::FirebasemlV2beta::Content>

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:



493
494
495
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 493

def contents
  @contents
end

#generation_config ⇒ Google::Apis::FirebasemlV2beta::GenerationConfig

Generation config. Corresponds to the JSON property generationConfig

Returns:



498
499
500
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 498

def generation_config
  @generation_config
end

#safety_settings ⇒ Array<Google::Apis::FirebasemlV2beta::SafetySetting>

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

Returns:



504
505
506
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 504

def safety_settings
  @safety_settings
end

#system_instruction ⇒ Google::Apis::FirebasemlV2beta::Content

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:



512
513
514
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 512

def system_instruction
  @system_instruction
end

#tool_config ⇒ Google::Apis::FirebasemlV2beta::ToolConfig

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

Returns:



517
518
519
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 517

def tool_config
  @tool_config
end

#tools ⇒ Array<Google::Apis::FirebasemlV2beta::Tool>

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:



525
526
527
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 525

def tools
  @tools
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



532
533
534
535
536
537
538
539
540
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 532

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