Package com.google.cloud.discoveryengine.v1beta

Interface CheckGroundingRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CheckGroundingRequest, CheckGroundingRequest.Builder
@Generated public interface CheckGroundingRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getGroundingConfig

      String getGroundingConfig()
       Required. The resource name of the grounding config, such as
 `projects/*/locations/global/groundingConfigs/default_grounding_config`.
      string grounding_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The groundingConfig.

    • getGroundingConfigBytes

      com.google.protobuf.ByteString getGroundingConfigBytes()
       Required. The resource name of the grounding config, such as
 `projects/*/locations/global/groundingConfigs/default_grounding_config`.
      string grounding_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for groundingConfig.

    • getAnswerCandidate

      String getAnswerCandidate()
       Answer candidate to check. It can have a maximum length of 4096 tokens.
      string answer_candidate = 2;
      Returns:
      The answerCandidate.

    • getAnswerCandidateBytes

      com.google.protobuf.ByteString getAnswerCandidateBytes()
       Answer candidate to check. It can have a maximum length of 4096 tokens.
      string answer_candidate = 2;
      Returns:
      The bytes for answerCandidate.

    • getFactsList

      List<GroundingFact> getFactsList()
       List of facts for the grounding check.
 We support up to 200 facts.
      repeated .google.cloud.discoveryengine.v1beta.GroundingFact facts = 3;

    • getFacts

      GroundingFact getFacts(int index)
       List of facts for the grounding check.
 We support up to 200 facts.
      repeated .google.cloud.discoveryengine.v1beta.GroundingFact facts = 3;

    • getFactsCount

      int getFactsCount()
       List of facts for the grounding check.
 We support up to 200 facts.
      repeated .google.cloud.discoveryengine.v1beta.GroundingFact facts = 3;

    • getFactsOrBuilderList

      List<? extends GroundingFactOrBuilder> getFactsOrBuilderList()
       List of facts for the grounding check.
 We support up to 200 facts.
      repeated .google.cloud.discoveryengine.v1beta.GroundingFact facts = 3;

    • getFactsOrBuilder

      GroundingFactOrBuilder getFactsOrBuilder(int index)
       List of facts for the grounding check.
 We support up to 200 facts.
      repeated .google.cloud.discoveryengine.v1beta.GroundingFact facts = 3;

    • hasGroundingSpec

      boolean hasGroundingSpec()
       Configuration of the grounding check.
      .google.cloud.discoveryengine.v1beta.CheckGroundingSpec grounding_spec = 4;
      Returns:
      Whether the groundingSpec field is set.

    • getGroundingSpec

      CheckGroundingSpec getGroundingSpec()
       Configuration of the grounding check.
      .google.cloud.discoveryengine.v1beta.CheckGroundingSpec grounding_spec = 4;
      Returns:
      The groundingSpec.

    • getGroundingSpecOrBuilder

      CheckGroundingSpecOrBuilder getGroundingSpecOrBuilder()
       Configuration of the grounding check.
      .google.cloud.discoveryengine.v1beta.CheckGroundingSpec grounding_spec = 4;

    • getUserLabelsCount

      int getUserLabelsCount()
       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](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 5;

    • containsUserLabels

      boolean containsUserLabels(String key)
       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](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 5;

    • getUserLabels

      @Deprecated Map<String,String> getUserLabels()
      Deprecated.
      Use getUserLabelsMap() instead.

    • getUserLabelsMap

      Map<String,String> getUserLabelsMap()
       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](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 5;

    • getUserLabelsOrDefault

      String getUserLabelsOrDefault(String key, String defaultValue)
       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](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 5;

    • getUserLabelsOrThrow

      String getUserLabelsOrThrow(String key)
       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](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 5;