Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EmbedContentRequest

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.EmbedContent.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1EmbedContentRequest

Returns a new instance of GoogleCloudAiplatformV1EmbedContentRequest.



8210
8211
8212
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8210

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

Instance Attribute Details

#auto_truncate ⇒ Boolean Also known as: auto_truncate?

Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead. Whether to silently truncate the input content if it's longer than the maximum sequence length. Corresponds to the JSON property autoTruncate

Returns:

  • (Boolean) 


8176
8177
8178
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8176

def auto_truncate
  @auto_truncate
end

#content ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Content

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 content

Returns:



8184
8185
8186
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8184

def content
  @content
end

#embed_content_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EmbedContentRequestEmbedContentConfig

Configurations for the EmbedContent API. Corresponds to the JSON property embedContentConfig

Returns:



8189
8190
8191
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8189

def embed_content_config
  @embed_content_config
end

#output_dimensionality ⇒ Fixnum

Optional. Deprecated: Please use EmbedContentConfig.output_dimensionality instead. Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end. Corresponds to the JSON property outputDimensionality

Returns:

  • (Fixnum) 


8196
8197
8198
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8196

def output_dimensionality
  @output_dimensionality
end

#task_type ⇒ String

Optional. Deprecated: Please use EmbedContentConfig.task_type instead. The task type of the embedding. Corresponds to the JSON property taskType

Returns:

  • (String) 


8202
8203
8204
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8202

def task_type
  @task_type
end

#title ⇒ String

Optional. Deprecated: Please use EmbedContentConfig.title instead. The title for the text. Corresponds to the JSON property title

Returns:

  • (String) 


8208
8209
8210
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8208

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8215
8216
8217
8218
8219
8220
8221
8222
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 8215

def update!(**args)
  @auto_truncate = args[:auto_truncate] if args.key?(:auto_truncate)
  @content = args[:content] if args.key?(:content)
  @embed_content_config = args[:embed_content_config] if args.key?(:embed_content_config)
  @output_dimensionality = args[:output_dimensionality] if args.key?(:output_dimensionality)
  @task_type = args[:task_type] if args.key?(:task_type)
  @title = args[:title] if args.key?(:title)
end