Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfig

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

Generation config.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1GenerationConfig

Returns a new instance of GoogleCloudAiplatformV1GenerationConfig.



13153
13154
13155
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13153

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

Instance Attribute Details

#audio_timestamp ⇒ Boolean Also known as: audio_timestamp?

Optional. If enabled, audio timestamp will be included in the request to the model. Corresponds to the JSON property audioTimestamp

Returns:

  • (Boolean) 


13029
13030
13031
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13029

def audio_timestamp
  @audio_timestamp
end

#candidate_count ⇒ Fixnum

Optional. Number of candidates to generate. Corresponds to the JSON property candidateCount

Returns:

  • (Fixnum) 


13035
13036
13037
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13035

def candidate_count
  @candidate_count
end

#enable_affective_dialog ⇒ Boolean Also known as: enable_affective_dialog?

Optional. If enabled, the model will detect emotions and adapt its responses accordingly. Corresponds to the JSON property enableAffectiveDialog

Returns:

  • (Boolean) 


13041
13042
13043
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13041

def enable_affective_dialog
  @enable_affective_dialog
end

#frequency_penalty ⇒ Float

Optional. Frequency penalties. Corresponds to the JSON property frequencyPenalty

Returns:

  • (Float) 


13047
13048
13049
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13047

def frequency_penalty
  @frequency_penalty
end

#logprobs ⇒ Fixnum

Optional. Logit probabilities. Corresponds to the JSON property logprobs

Returns:

  • (Fixnum) 


13052
13053
13054
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13052

def logprobs
  @logprobs
end

#max_output_tokens ⇒ Fixnum

Optional. The maximum number of output tokens to generate per message. Corresponds to the JSON property maxOutputTokens

Returns:

  • (Fixnum) 


13057
13058
13059
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13057

def max_output_tokens
  @max_output_tokens
end

#media_resolution ⇒ String

Optional. If specified, the media resolution specified will be used. Corresponds to the JSON property mediaResolution

Returns:

  • (String) 


13062
13063
13064
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13062

def media_resolution
  @media_resolution
end

#presence_penalty ⇒ Float

Optional. Positive penalties. Corresponds to the JSON property presencePenalty

Returns:

  • (Float) 


13067
13068
13069
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13067

def presence_penalty
  @presence_penalty
end

#response_json_schema ⇒ Object

Optional. Output schema of the generated response. This is an alternative to response_schema that accepts JSON Schema. If set, response_schema must be omitted, but response_mime_type is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - $id - $defs - $ref - $ anchor - type - format - title - description - enum (for strings and numbers) - items - prefixItems - minItems - maxItems - minimum - maximum - anyOf - oneOf (interpreted the same as anyOf) - properties

  • additionalProperties - required The non-standard propertyOrdering property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If $ref is set on a sub-schema, no other properties, except for than those starting as a $, may be set. Corresponds to the JSON property responseJsonSchema

Returns:

  • (Object) 


13084
13085
13086
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13084

def response_json_schema
  @response_json_schema
end

#response_logprobs ⇒ Boolean Also known as: response_logprobs?

Optional. If true, export the logprobs results in response. Corresponds to the JSON property responseLogprobs

Returns:

  • (Boolean) 


13089
13090
13091
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13089

def response_logprobs
  @response_logprobs
end

#response_mime_type ⇒ String

Optional. Output response mimetype of the generated candidate text. Supported mimetype: - text/plain: (default) Text output. - application/json: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. Corresponds to the JSON property responseMimeType

Returns:

  • (String) 


13099
13100
13101
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13099

def response_mime_type
  @response_mime_type
end

#response_modalities ⇒ Array<String>

Optional. The modalities of the response. Corresponds to the JSON property responseModalities

Returns:

  • (Array<String>) 


13104
13105
13106
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13104

def response_modalities
  @response_modalities
end

#response_schema ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schema

Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object. More fields may be added in the future as needed. Corresponds to the JSON property responseSchema

Returns:



13111
13112
13113
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13111

def response_schema
  @response_schema
end

#routing_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfigRoutingConfig

The configuration for routing the request to a specific model. Corresponds to the JSON property routingConfig

Returns:



13116
13117
13118
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13116

def routing_config
  @routing_config
end

#seed ⇒ Fixnum

Optional. Seed. Corresponds to the JSON property seed

Returns:

  • (Fixnum) 


13121
13122
13123
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13121

def seed
  @seed
end

#speech_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1SpeechConfig

The speech generation config. Corresponds to the JSON property speechConfig

Returns:



13126
13127
13128
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13126

def speech_config
  @speech_config
end

#stop_sequences ⇒ Array<String>

Optional. Stop sequences. Corresponds to the JSON property stopSequences

Returns:

  • (Array<String>) 


13131
13132
13133
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13131

def stop_sequences
  @stop_sequences
end

#temperature ⇒ Float

Optional. Controls the randomness of predictions. Corresponds to the JSON property temperature

Returns:

  • (Float) 


13136
13137
13138
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13136

def temperature
  @temperature
end

#thinking_config ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerationConfigThinkingConfig

Config for thinking features. Corresponds to the JSON property thinkingConfig

Returns:



13141
13142
13143
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13141

def thinking_config
  @thinking_config
end

#top_k ⇒ Float

Optional. If specified, top-k sampling will be used. Corresponds to the JSON property topK

Returns:

  • (Float) 


13146
13147
13148
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13146

def top_k
  @top_k
end

#top_p ⇒ Float

Optional. If specified, nucleus sampling will be used. Corresponds to the JSON property topP

Returns:

  • (Float) 


13151
13152
13153
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13151

def top_p
  @top_p
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13158
13159
13160
13161
13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 13158

def update!(**args)
  @audio_timestamp = args[:audio_timestamp] if args.key?(:audio_timestamp)
  @candidate_count = args[:candidate_count] if args.key?(:candidate_count)
  @enable_affective_dialog = args[:enable_affective_dialog] if args.key?(:enable_affective_dialog)
  @frequency_penalty = args[:frequency_penalty] if args.key?(:frequency_penalty)
  @logprobs = args[:logprobs] if args.key?(:logprobs)
  @max_output_tokens = args[:max_output_tokens] if args.key?(:max_output_tokens)
  @media_resolution = args[:media_resolution] if args.key?(:media_resolution)
  @presence_penalty = args[:presence_penalty] if args.key?(:presence_penalty)
  @response_json_schema = args[:response_json_schema] if args.key?(:response_json_schema)
  @response_logprobs = args[:response_logprobs] if args.key?(:response_logprobs)
  @response_mime_type = args[:response_mime_type] if args.key?(:response_mime_type)
  @response_modalities = args[:response_modalities] if args.key?(:response_modalities)
  @response_schema = args[:response_schema] if args.key?(:response_schema)
  @routing_config = args[:routing_config] if args.key?(:routing_config)
  @seed = args[:seed] if args.key?(:seed)
  @speech_config = args[:speech_config] if args.key?(:speech_config)
  @stop_sequences = args[:stop_sequences] if args.key?(:stop_sequences)
  @temperature = args[:temperature] if args.key?(:temperature)
  @thinking_config = args[:thinking_config] if args.key?(:thinking_config)
  @top_k = args[:top_k] if args.key?(:top_k)
  @top_p = args[:top_p] if args.key?(:top_p)
end