Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingRequest

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

Overview

Request message for GroundedGenerationService.CheckGrounding method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1CheckGroundingRequest

Returns a new instance of GoogleCloudDiscoveryengineV1CheckGroundingRequest.



622
623
624
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 622

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

Instance Attribute Details

#answer_candidate ⇒ String

Answer candidate to check. Can have a maximum length of 1024 characters. Corresponds to the JSON property answerCandidate

Returns:

  • (String) 


595
596
597
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 595

def answer_candidate
  @answer_candidate
end

#facts ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GroundingFact>

List of facts for the grounding check. We support up to 200 facts. Corresponds to the JSON property facts

Returns:



600
601
602
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 600

def facts
  @facts
end

#grounding_spec ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingSpec

Specification for the grounding check. Corresponds to the JSON property groundingSpec

Returns:



605
606
607
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 605

def grounding_spec
  @grounding_spec
end

#user_labels ⇒ Hash<String,String>

The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See Google Cloud Document for more details. Corresponds to the JSON property userLabels

Returns:

  • (Hash<String,String>) 


620
621
622
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 620

def user_labels
  @user_labels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



627
628
629
630
631
632
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 627

def update!(**args)
  @answer_candidate = args[:answer_candidate] if args.key?(:answer_candidate)
  @facts = args[:facts] if args.key?(:facts)
  @grounding_spec = args[:grounding_spec] if args.key?(:grounding_spec)
  @user_labels = args[:user_labels] if args.key?(:user_labels)
end