Discovery Engine v1 API - Class CheckGroundingRequest (1.5.0)

Version 1.5.0

• 1.6.0 (latest)
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0-beta06

public sealed class CheckGroundingRequest : IMessage<CheckGroundingRequest>, IEquatable<CheckGroundingRequest>, IDeepCloneable<CheckGroundingRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class CheckGroundingRequest.

Request message for [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1.GroundedGenerationService.CheckGrounding] method.

Inheritance

object > CheckGroundingRequest

Implements

IMessageCheckGroundingRequest, IEquatableCheckGroundingRequest, IDeepCloneableCheckGroundingRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

CheckGroundingRequest()

public CheckGroundingRequest()

CheckGroundingRequest(CheckGroundingRequest)

public CheckGroundingRequest(CheckGroundingRequest other)

Parameter
Name	Description
other	CheckGroundingRequest

Properties

AnswerCandidate

public string AnswerCandidate { get; set; }

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

Property Value
Type	Description
string

Facts

public RepeatedField<GroundingFact> Facts { get; }

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

Property Value
Type	Description
RepeatedFieldGroundingFact

GroundingConfig

public string GroundingConfig { get; set; }

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

Property Value
Type	Description
string

GroundingConfigAsGroundingConfigName

public GroundingConfigName GroundingConfigAsGroundingConfigName { get; set; }

GroundingConfigName-typed view over the GroundingConfig resource name property.

Property Value
Type	Description
GroundingConfigName

GroundingSpec

public CheckGroundingSpec GroundingSpec { get; set; }

Configuration of the grounding check.

Property Value
Type	Description
CheckGroundingSpec

UserLabels

public MapField<string, string> UserLabels { get; }

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.

Property Value
Type	Description
MapFieldstringstring