Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata

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 metadata of Datasets that contain Text Prompt data.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata

Returns a new instance of GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata.



25460
25461
25462
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25460

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

Instance Attribute Details

#candidate_count ⇒ Fixnum

Number of candidates. Corresponds to the JSON property candidateCount

Returns:

  • (Fixnum) 


25367
25368
25369
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25367

def candidate_count
  @candidate_count
end

#gcs_uri ⇒ String

The Google Cloud Storage URI that stores the prompt data. Corresponds to the JSON property gcsUri

Returns:

  • (String) 


25372
25373
25374
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25372

def gcs_uri
  @gcs_uri
end

#grounding_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig

The configuration for grounding checking. Corresponds to the JSON property groundingConfig

Returns:



25377
25378
25379
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25377

def grounding_config
  @grounding_config
end

#has_prompt_variable ⇒ Boolean Also known as: has_prompt_variable?

Whether the prompt dataset has prompt variable. Corresponds to the JSON property hasPromptVariable

Returns:

  • (Boolean) 


25382
25383
25384
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25382

def has_prompt_variable
  @has_prompt_variable
end

#logprobs ⇒ Boolean Also known as: logprobs?

Whether or not the user has enabled logit probabilities in the model parameters. Corresponds to the JSON property logprobs

Returns:

  • (Boolean) 


25389
25390
25391
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25389

def logprobs
  @logprobs
end

#max_output_tokens ⇒ Fixnum

Value of the maximum number of tokens generated set when the dataset was saved. Corresponds to the JSON property maxOutputTokens

Returns:

  • (Fixnum) 


25395
25396
25397
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25395

def max_output_tokens
  @max_output_tokens
end

#note ⇒ String

User-created prompt note. Note size limit is 2KB. Corresponds to the JSON property note

Returns:

  • (String) 


25400
25401
25402
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25400

def note
  @note
end

#prompt_type ⇒ String

Type of the prompt dataset. Corresponds to the JSON property promptType

Returns:

  • (String) 


25405
25406
25407
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25405

def prompt_type
  @prompt_type
end

#seed_enabled ⇒ Boolean Also known as: seed_enabled?

Seeding enables model to return a deterministic response on a best effort basis. Determinism isn't guaranteed. This field determines whether or not seeding is enabled. Corresponds to the JSON property seedEnabled

Returns:

  • (Boolean) 


25412
25413
25414
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25412

def seed_enabled
  @seed_enabled
end

#seed_value ⇒ Fixnum

The actual value of the seed. Corresponds to the JSON property seedValue

Returns:

  • (Fixnum) 


25418
25419
25420
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25418

def seed_value
  @seed_value
end

#stop_sequences ⇒ Array<String>

Customized stop sequences. Corresponds to the JSON property stopSequences

Returns:

  • (Array<String>) 


25423
25424
25425
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25423

def stop_sequences
  @stop_sequences
end

#system_instruction ⇒ String

The content of the prompt dataset system instruction. Corresponds to the JSON property systemInstruction

Returns:

  • (String) 


25428
25429
25430
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25428

def system_instruction
  @system_instruction
end

#system_instruction_gcs_uri ⇒ String

The Google Cloud Storage URI that stores the system instruction, starting with gs://. Corresponds to the JSON property systemInstructionGcsUri

Returns:

  • (String) 


25434
25435
25436
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25434

def system_instruction_gcs_uri
  @system_instruction_gcs_uri
end

#temperature ⇒ Float

Temperature value used for sampling set when the dataset was saved. This value is used to tune the degree of randomness. Corresponds to the JSON property temperature

Returns:

  • (Float) 


25440
25441
25442
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25440

def temperature
  @temperature
end

#text ⇒ String

The content of the prompt dataset. Corresponds to the JSON property text

Returns:

  • (String) 


25445
25446
25447
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25445

def text
  @text
end

#top_k ⇒ Fixnum

Top K value set when the dataset was saved. This value determines how many candidates with highest probability from the vocab would be selected for each decoding step. Corresponds to the JSON property topK

Returns:

  • (Fixnum) 


25452
25453
25454
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25452

def top_k
  @top_k
end

#top_p ⇒ Float

Top P value set when the dataset was saved. Given topK tokens for decoding, top candidates will be selected until the sum of their probabilities is topP. Corresponds to the JSON property topP

Returns:

  • (Float) 


25458
25459
25460
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25458

def top_p
  @top_p
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



25465
25466
25467
25468
25469
25470
25471
25472
25473
25474
25475
25476
25477
25478
25479
25480
25481
25482
25483
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25465

def update!(**args)
  @candidate_count = args[:candidate_count] if args.key?(:candidate_count)
  @gcs_uri = args[:gcs_uri] if args.key?(:gcs_uri)
  @grounding_config = args[:grounding_config] if args.key?(:grounding_config)
  @has_prompt_variable = args[:has_prompt_variable] if args.key?(:has_prompt_variable)
  @logprobs = args[:logprobs] if args.key?(:logprobs)
  @max_output_tokens = args[:max_output_tokens] if args.key?(:max_output_tokens)
  @note = args[:note] if args.key?(:note)
  @prompt_type = args[:prompt_type] if args.key?(:prompt_type)
  @seed_enabled = args[:seed_enabled] if args.key?(:seed_enabled)
  @seed_value = args[:seed_value] if args.key?(:seed_value)
  @stop_sequences = args[:stop_sequences] if args.key?(:stop_sequences)
  @system_instruction = args[:system_instruction] if args.key?(:system_instruction)
  @system_instruction_gcs_uri = args[:system_instruction_gcs_uri] if args.key?(:system_instruction_gcs_uri)
  @temperature = args[:temperature] if args.key?(:temperature)
  @text = args[:text] if args.key?(:text)
  @top_k = args[:top_k] if args.key?(:top_k)
  @top_p = args[:top_p] if args.key?(:top_p)
end