Class: Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GenerationConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firebaseml_v2beta/classes.rb,
lib/google/apis/firebaseml_v2beta/representations.rb,
lib/google/apis/firebaseml_v2beta/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1GenerationConfig

Returns a new instance of GoogleCloudAiplatformV1beta1GenerationConfig.



1877
1878
1879
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1877

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

Instance Attribute Details

#audio_timestamp ⇒ Boolean Also known as: audio_timestamp?

Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. Corresponds to the JSON property audioTimestamp

Returns:

  • (Boolean) 


1690
1691
1692
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1690

def audio_timestamp
  @audio_timestamp
end

#audio_transcription_config ⇒ Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1AudioTranscriptionConfig

Configuration for speech recognition (transcription). Corresponds to the JSON property audioTranscriptionConfig

Returns:



1696
1697
1698
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1696

def audio_transcription_config
  @audio_transcription_config
end

#candidate_count ⇒ Fixnum

Optional. The number of candidate responses to generate. A higher candidate_count can provide more options to choose from, but it also consumes more resources. This can be useful for generating a variety of responses and selecting the best one. Corresponds to the JSON property candidateCount

Returns:

  • (Fixnum) 


1704
1705
1706
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1704

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. For example, if the model detects that the user is frustrated, it may provide a more empathetic response. Corresponds to the JSON property enableAffectiveDialog

Returns:

  • (Boolean) 


1711
1712
1713
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1711

def enable_affective_dialog
  @enable_affective_dialog
end

#frequency_penalty ⇒ Float

Optional. Penalizes tokens based on their frequency in the generated text. A positive value helps to reduce the repetition of words and phrases. Valid values can range from [-2.0, 2.0]. Corresponds to the JSON property frequencyPenalty

Returns:

  • (Float) 


1719
1720
1721
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1719

def frequency_penalty
  @frequency_penalty
end

#image_config ⇒ Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1ImageConfig

Configuration for image generation. This message allows you to control various aspects of image generation, such as the output format, aspect ratio, and whether the model can generate images of people. Corresponds to the JSON property imageConfig

Returns:



1726
1727
1728
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1726

def image_config
  @image_config
end

#logprobs ⇒ Fixnum

Optional. The number of top log probabilities to return for each token. This can be used to see which other tokens were considered likely candidates for a given position. A higher value will return more options, but it will also increase the size of the response. Corresponds to the JSON property logprobs

Returns:

  • (Fixnum) 


1734
1735
1736
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1734

def logprobs
  @logprobs
end

#max_output_tokens ⇒ Fixnum

Optional. The maximum number of tokens to generate in the response. A token is approximately four characters. The default value varies by model. This parameter can be used to control the length of the generated text and prevent overly long responses. Corresponds to the JSON property maxOutputTokens

Returns:

  • (Fixnum) 


1742
1743
1744
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1742

def max_output_tokens
  @max_output_tokens
end

#media_resolution ⇒ String

Optional. The token resolution at which input media content is sampled. This is used to control the trade-off between the quality of the response and the number of tokens used to represent the media. A higher resolution allows the model to perceive more detail, which can lead to a more nuanced response, but it will also use more tokens. This does not affect the image dimensions sent to the model. Corresponds to the JSON property mediaResolution

Returns:

  • (String) 


1752
1753
1754
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1752

def media_resolution
  @media_resolution
end

#model_config ⇒ Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GenerationConfigModelConfig

Config for model selection. Corresponds to the JSON property modelConfig

Returns:



1757
1758
1759
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1757

def model_config
  @model_config
end

#presence_penalty ⇒ Float

Optional. Penalizes tokens that have already appeared in the generated text. A positive value encourages the model to generate more diverse and less repetitive text. Valid values can range from [-2.0, 2.0]. Corresponds to the JSON property presencePenalty

Returns:

  • (Float) 


1764
1765
1766
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1764

def presence_penalty
  @presence_penalty
end

#response_format ⇒ Array<Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1ResponseFormat>

Optional. New response format field for the model to configure output formatting and delivery. Corresponds to the JSON property responseFormat

Returns:



1770
1771
1772
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1770

def response_format
  @response_format
end

#response_json_schema ⇒ Object

Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to application/json. Deprecated: Use response_format instead. Corresponds to the JSON property responseJsonSchema

Returns:

  • (Object) 


1777
1778
1779
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1777

def response_json_schema
  @response_json_schema
end

#response_logprobs ⇒ Boolean Also known as: response_logprobs?

Optional. If set to true, the log probabilities of the output tokens are returned. Log probabilities are the logarithm of the probability of a token appearing in the output. A higher log probability means the token is more likely to be generated. This can be useful for analyzing the model's confidence in its own output and for debugging. Corresponds to the JSON property responseLogprobs

Returns:

  • (Boolean) 


1786
1787
1788
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1786

def response_logprobs
  @response_logprobs
end

#response_mime_type ⇒ String

Optional. The IANA standard MIME type of the response. The model will generate output that conforms to this MIME type. Supported values include 'text/plain' ( default) and 'application/json'. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. Deprecated: Use response_format instead. Corresponds to the JSON property responseMimeType

Returns:

  • (String) 


1796
1797
1798
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1796

def response_mime_type
  @response_mime_type
end

#response_modalities ⇒ Array<String>

Optional. The modalities of the response. The model will generate a response that includes all the specified modalities. For example, if this is set to [ TEXT, IMAGE], the response will include both text and an image. Corresponds to the JSON property responseModalities

Returns:

  • (Array<String>) 


1803
1804
1805
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1803

def response_modalities
  @response_modalities
end

#response_schema ⇒ Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1Schema

Defines the schema of input and output data. This is a subset of the OpenAPI 3.0 Schema Object. Corresponds to the JSON property responseSchema

Returns:



1809
1810
1811
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1809

def response_schema
  @response_schema
end

#routing_config ⇒ Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig

The configuration for routing the request to a specific model. This can be used to control which model is used for the generation, either automatically or by specifying a model name. Corresponds to the JSON property routingConfig

Returns:



1816
1817
1818
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1816

def routing_config
  @routing_config
end

#seed ⇒ Fixnum

Optional. A seed for the random number generator. By setting a seed, you can make the model's output mostly deterministic. For a given prompt and parameters (like temperature, top_p, etc.), the model will produce the same response every time. However, it's not a guaranteed absolute deterministic behavior. This is different from parameters like temperature, which control the level of randomness. seed ensures that the "random" choices the model makes are the same on every run, making it essential for testing and ensuring reproducible results. Corresponds to the JSON property seed

Returns:

  • (Fixnum) 


1828
1829
1830
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1828

def seed
  @seed
end

#speech_config ⇒ Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1SpeechConfig

Configuration for speech generation. Corresponds to the JSON property speechConfig

Returns:



1833
1834
1835
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1833

def speech_config
  @speech_config
end

#stop_sequences ⇒ Array<String>

Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. Corresponds to the JSON property stopSequences

Returns:

  • (Array<String>) 


1842
1843
1844
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1842

def stop_sequences
  @stop_sequences
end

#temperature ⇒ Float

Optional. Controls the randomness of the output. A higher temperature results in more creative and diverse responses, while a lower temperature makes the output more predictable and focused. The valid range is (0.0, 2.0]. Corresponds to the JSON property temperature

Returns:

  • (Float) 


1849
1850
1851
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1849

def temperature
  @temperature
end

#thinking_config ⇒ Google::Apis::FirebasemlV2beta::GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig

Configuration for the model's thinking features. "Thinking" is a process where the model breaks down a complex task into smaller, manageable steps. This allows the model to reason about the task, plan its approach, and execute the plan to generate a high-quality response. Corresponds to the JSON property thinkingConfig

Returns:



1857
1858
1859
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1857

def thinking_config
  @thinking_config
end

#top_k ⇒ Float

Optional. Specifies the top-k sampling threshold. The model considers only the top k most probable tokens for the next token. This can be useful for generating more coherent and less random text. For example, a top_k of 40 means the model will choose the next word from the 40 most likely words. Corresponds to the JSON property topK

Returns:

  • (Float) 


1865
1866
1867
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1865

def top_k
  @top_k
end

#top_p ⇒ Float

Optional. Specifies the nucleus sampling threshold. The model considers only the smallest set of tokens whose cumulative probability is at least top_p. This helps generate more diverse and less repetitive responses. For example, a top_p of 0.9 means the model considers tokens until the cumulative probability of the tokens to select from reaches 0.9. It's recommended to adjust either temperature or top_p, but not both. Corresponds to the JSON property topP

Returns:

  • (Float) 


1875
1876
1877
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1875

def top_p
  @top_p
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 1882

def update!(**args)
  @audio_timestamp = args[:audio_timestamp] if args.key?(:audio_timestamp)
  @audio_transcription_config = args[:audio_transcription_config] if args.key?(:audio_transcription_config)
  @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)
  @image_config = args[:image_config] if args.key?(:image_config)
  @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)
  @model_config = args[:model_config] if args.key?(:model_config)
  @presence_penalty = args[:presence_penalty] if args.key?(:presence_penalty)
  @response_format = args[:response_format] if args.key?(:response_format)
  @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