Class: Google::Cloud::DiscoveryEngine::V1::CheckGroundingRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb

Overview

Request message for GroundedGenerationService.CheckGrounding method.

Defined Under Namespace

Classes: UserLabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#answer_candidate ⇒ ::String

Returns Answer candidate to check. Can have a maximum length of 1024 characters.

Returns:

  • (::String) —

    Answer candidate to check. Can have a maximum length of 1024 characters.



456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb', line 456

class CheckGroundingRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#facts ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::GroundingFact>

Returns List of facts for the grounding check. We support up to 200 facts.

Returns:



456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb', line 456

class CheckGroundingRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#grounding_config ⇒ ::String

Returns Required. The resource name of the grounding config, such as projects/*/locations/global/groundingConfigs/default_grounding_config.

Returns:

  • (::String) —

    Required. The resource name of the grounding config, such as projects/*/locations/global/groundingConfigs/default_grounding_config.



456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb', line 456

class CheckGroundingRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#grounding_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::CheckGroundingSpec

Returns Configuration of the grounding check.

Returns:



456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb', line 456

class CheckGroundingRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#user_labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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.

Returns:

  • (::Google::Protobuf::Map{::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.



456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb', line 456

class CheckGroundingRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class UserLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end