qconnect/aws.sdk.kotlin.services.qconnect.model/UpdateAiGuardrailRequest/Builder

Builder

class Builder

Properties

aiGuardrailId

var aiGuardrailId: String?

The identifier of the Amazon Q in Connect AI Guardrail.

assistantId

var assistantId: String?

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

blockedInputMessaging

var blockedInputMessaging: String?

The message to return when the AI Guardrail blocks a prompt.

blockedOutputsMessaging

var blockedOutputsMessaging: String?

The message to return when the AI Guardrail blocks a model response.

clientToken

var clientToken: String?

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs..

contentPolicyConfig

var contentPolicyConfig: AiGuardrailContentPolicyConfig?

The content filter policies to configure for the AI Guardrail.

contextualGroundingPolicyConfig

var contextualGroundingPolicyConfig: AiGuardrailContextualGroundingPolicyConfig?

The contextual grounding policy configuration used to create an AI Guardrail.

description

var description: String?

A description of the AI Guardrail.

sensitiveInformationPolicyConfig

var sensitiveInformationPolicyConfig: AiGuardrailSensitiveInformationPolicyConfig?

The sensitive information policy to configure for the AI Guardrail.

topicPolicyConfig

var topicPolicyConfig: AiGuardrailTopicPolicyConfig?

The topic policies to configure for the AI Guardrail.

visibilityStatus

var visibilityStatus: VisibilityStatus?

The visibility status of the Amazon Q in Connect AI Guardrail.

wordPolicyConfig

var wordPolicyConfig: AiGuardrailWordPolicyConfig?

The word policy you configure for the AI Guardrail.

Functions

contentPolicyConfig

fun contentPolicyConfig(block: AiGuardrailContentPolicyConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.qconnect.model.AiGuardrailContentPolicyConfig inside the given block

contextualGroundingPolicyConfig

fun contextualGroundingPolicyConfig(block: AiGuardrailContextualGroundingPolicyConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.qconnect.model.AiGuardrailContextualGroundingPolicyConfig inside the given block

sensitiveInformationPolicyConfig

fun sensitiveInformationPolicyConfig(block: AiGuardrailSensitiveInformationPolicyConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.qconnect.model.AiGuardrailSensitiveInformationPolicyConfig inside the given block

topicPolicyConfig

fun topicPolicyConfig(block: AiGuardrailTopicPolicyConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.qconnect.model.AiGuardrailTopicPolicyConfig inside the given block

wordPolicyConfig

fun wordPolicyConfig(block: AiGuardrailWordPolicyConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.qconnect.model.AiGuardrailWordPolicyConfig inside the given block