AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

The details for the guardrails contextual grounding filter.

Inheritance Hierarchy

System.Object
  Amazon.BedrockRuntime.Model.GuardrailContextualGroundingFilter

Namespace: Amazon.BedrockRuntime.Model
Assembly: AWSSDK.BedrockRuntime.dll
Version: 3.x.y.z

Syntax

C# 
public class GuardrailContextualGroundingFilter

The GuardrailContextualGroundingFilter type exposes the following members

Constructors

NameDescription
Public Method GuardrailContextualGroundingFilter()

Properties

NameTypeDescription
Public Property Action Amazon.BedrockRuntime.GuardrailContextualGroundingPolicyAction

Gets and sets the property Action.

The action performed by the guardrails contextual grounding filter.

Public Property Detected System.Nullable<System.Boolean>

Gets and sets the property Detected.

Indicates whether content that fails the contextual grounding evaluation (grounding or relevance score less than the corresponding threshold) was detected.

Public Property Score System.Nullable<System.Double>

Gets and sets the property Score.

The score generated by contextual grounding filter.

Public Property Threshold System.Nullable<System.Double>

Gets and sets the property Threshold.

The threshold used by contextual grounding filter to determine whether the content is grounded or not.

Public Property Type Amazon.BedrockRuntime.GuardrailContextualGroundingFilterType

Gets and sets the property Type.

The contextual grounding filter type.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer