Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GeminiExample

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

Format for Gemini examples used for Vertex Multimodal datasets.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1GeminiExample

Returns a new instance of GoogleCloudAiplatformV1beta1GeminiExample.



26927
26928
26929
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 26927

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) 


26860
26861
26862
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 26860

def cached_content
  @cached_content
end

#contents ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content>

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:



26867
26868
26869
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 26867

def contents
  @contents
end

#generation_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig

Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. Corresponds to the JSON property generationConfig

Returns:



26874
26875
26876
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 26874

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>) 


26883
26884
26885
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 26883

def labels
  @labels
end

#model ⇒ String

Optional. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: projects/project/locations/ location/publishers/*/models/* Tuned model endpoint format: projects/ project/locations/location/endpoints/endpoint` Corresponds to the JSON propertymodel`

Returns:

  • (String) 


26891
26892
26893
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 26891

def model
  @model
end

#model_armor_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelArmorConfig

Configuration for Model Armor. Model Armor is a Google Cloud service that provides safety and security filtering for prompts and responses. It helps protect your AI applications from risks such as harmful content, sensitive data leakage, and prompt injection attacks. Corresponds to the JSON property modelArmorConfig

Returns:



26899
26900
26901
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 26899

def model_armor_config
  @model_armor_config
end

#safety_settings ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SafetySetting>

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

Returns:



26905
26906
26907
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 26905

def safety_settings
  @safety_settings
end

#system_instruction ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content

The structured data content of a message. A Content message contains a role field, which indicates the producer of the content, and a parts field, which contains the multi-part data of the message. Corresponds to the JSON property systemInstruction

Returns:



26912
26913
26914
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 26912

def system_instruction
  @system_instruction
end

#tool_config ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ToolConfig

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

Returns:



26917
26918
26919
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 26917

def tool_config
  @tool_config
end

#tools ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Tool>

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:



26925
26926
26927
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 26925

def tools
  @tools
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



26932
26933
26934
26935
26936
26937
26938
26939
26940
26941
26942
26943
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 26932

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)
  @labels = args[:labels] if args.key?(:labels)
  @model = args[:model] if args.key?(:model)
  @model_armor_config = args[:model_armor_config] if args.key?(:model_armor_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