Class: Google::Apis::CesV1::DataStoreToolGroundingConfig

Inherits:

Object

• Object
• Google::Apis::CesV1::DataStoreToolGroundingConfig

Includes:

Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport

Defined in:

lib/google/apis/ces_v1/classes.rb,
lib/google/apis/ces_v1/representations.rb,
lib/google/apis/ces_v1/representations.rb

Overview

Grounding configuration.

Instance Attribute Summary

• #disabled ⇒ Boolean (also: #disabled?)

  Optional.

• #grounding_level ⇒ Float

  Optional.

Instance Method Summary

• #initialize(**args) ⇒ DataStoreToolGroundingConfig constructor

  A new instance of DataStoreToolGroundingConfig.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ DataStoreToolGroundingConfig

Returns a new instance of DataStoreToolGroundingConfig.

# File 'lib/google/apis/ces_v1/classes.rb', line 2516

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

Instance Attribute Details

#disabled ⇒ Boolean Also known as: disabled?

Optional. Whether grounding is disabled. Corresponds to the JSON property disabled

Returns:

• (Boolean)

# File 'lib/google/apis/ces_v1/classes.rb', line 2503

def disabled
  @disabled
end

#grounding_level ⇒ Float

Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of [1, 5]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned. Corresponds to the JSON property groundingLevel

Returns:

• (Float)

# File 'lib/google/apis/ces_v1/classes.rb', line 2514

def grounding_level
  @grounding_level
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/ces_v1/classes.rb', line 2521

def update!(**args)
  @disabled = args[:disabled] if args.key?(:disabled)
  @grounding_level = args[:grounding_level] if args.key?(:grounding_level)
end