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.



37044
37045
37046
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 37044

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

Instance Attribute Details

#candidate_count ⇒ Fixnum

Number of candidates. Corresponds to the JSON property candidateCount

Returns:

  • (Fixnum) 


36946
36947
36948
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36946

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) 


36951
36952
36953
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36951

def gcs_uri
  @gcs_uri
end

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

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

Returns:



36956
36957
36958
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36956

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) 


36961
36962
36963
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36961

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) 


36968
36969
36970
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36968

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) 


36974
36975
36976
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36974

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) 


36979
36980
36981
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36979

def note
  @note
end

#prompt_api_schema ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SchemaPromptApiSchema

The A2 schema of a prompt. Corresponds to the JSON property promptApiSchema

Returns:



36984
36985
36986
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36984

def prompt_api_schema
  @prompt_api_schema
end

#prompt_type ⇒ String

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

Returns:

  • (String) 


36989
36990
36991
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36989

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) 


36996
36997
36998
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 36996

def seed_enabled
  @seed_enabled
end

#seed_value ⇒ Fixnum

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

Returns:

  • (Fixnum) 


37002
37003
37004
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 37002

def seed_value
  @seed_value
end

#stop_sequences ⇒ Array<String>

Customized stop sequences. Corresponds to the JSON property stopSequences

Returns:

  • (Array<String>) 


37007
37008
37009
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 37007

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) 


37012
37013
37014
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 37012

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) 


37018
37019
37020
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 37018

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) 


37024
37025
37026
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 37024

def temperature
  @temperature
end

#text ⇒ String

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

Returns:

  • (String) 


37029
37030
37031
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 37029

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) 


37036
37037
37038
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 37036

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) 


37042
37043
37044
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 37042

def top_p
  @top_p
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



37049
37050
37051
37052
37053
37054
37055
37056
37057
37058
37059
37060
37061
37062
37063
37064
37065
37066
37067
37068
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 37049

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_api_schema = args[:prompt_api_schema] if args.key?(:prompt_api_schema)
  @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