Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingRequest (v0.12.0)

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingRequest.

Request message for GroundedGenerationService.CheckGrounding method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#answer_candidate

def answer_candidate() -> ::String
Returns
  • (::String) — Answer candidate to check. Can have a maximum length of 1024 characters.

#answer_candidate=

def answer_candidate=(value) -> ::String
Parameter
  • value (::String) — 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.

#facts

def facts() -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::GroundingFact>
Returns

#facts=

def facts=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1beta::GroundingFact>
Parameter
Returns

#grounding_config

def grounding_config() -> ::String
Returns
  • (::String) — Required. The resource name of the grounding config, such as projects/*/locations/global/groundingConfigs/default_grounding_config.

#grounding_config=

def grounding_config=(value) -> ::String
Parameter
  • value (::String) — 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.

#grounding_spec

def grounding_spec() -> ::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingSpec
Returns

#grounding_spec=

def grounding_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingSpec
Parameter
Returns

#user_labels

def user_labels() -> ::Google::Protobuf::Map{::String => ::String}
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.

#user_labels=

def user_labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::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.

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.