Module Values.AIGuardrailDataSource

The data for the AI Guardrail

Sourcetype nonrec t = {
  1. assistantId : Uuid.t option;
    (*

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

    *)
  2. assistantArn : Arn.t option;
    (*

    The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

    *)
  3. aiGuardrailArn : Arn.t option;
    (*

    The Amazon Resource Name (ARN) of the AI Guardrail.

    *)
  4. aiGuardrailId : Uuid.t option;
    (*

    The identifier of the Amazon Q in Connect AI Guardrail.

    *)
  5. name : Name.t option;
    (*

    The name of the AI Guardrail.

    *)
  6. visibilityStatus : VisibilityStatus.t option;
    (*

    The visibility status of the AI Guardrail.

    *)
  7. blockedInputMessaging : AIGuardrailBlockedMessaging.t option;
    (*

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

    *)
  8. blockedOutputsMessaging : AIGuardrailBlockedMessaging.t option;
    (*

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

    *)
  9. description : AIGuardrailDescription.t option;
    (*

    A description of the AI Guardrail.

    *)
  10. topicPolicyConfig : AIGuardrailTopicPolicyConfig.t option;
    (*

    Contains details about topics that the AI Guardrail should identify and deny.

    *)
  11. contentPolicyConfig : AIGuardrailContentPolicyConfig.t option;
    (*

    Contains details about how to handle harmful content.

    *)
  12. wordPolicyConfig : AIGuardrailWordPolicyConfig.t option;
    (*

    Contains details about the word policy to configured for the AI Guardrail.

    *)
  13. sensitiveInformationPolicyConfig : AIGuardrailSensitiveInformationPolicyConfig.t option;
    (*

    Contains details about PII entities and regular expressions to configure for the AI Guardrail.

    *)
  14. contextualGroundingPolicyConfig : AIGuardrailContextualGroundingPolicyConfig.t option;
    (*

    The policy configuration details for the AI Guardrail's contextual grounding policy.

    *)
  15. tags : Tags.t option;
    (*

    The tags used to organize, track, or control access for this resource.

    *)
  16. status : Status.t option;
    (*

    The status of the AI Guardrail.

    *)
  17. modifiedTime : Timestamp.t option;
    (*

    The time the AI Guardrail was last modified.

    *)
}
Sourceval make : ?assistantId:??? -> ?assistantArn:??? -> ?aiGuardrailArn:??? -> ?aiGuardrailId:??? -> ?name:??? -> ?visibilityStatus:??? -> ?blockedInputMessaging:??? -> ?blockedOutputsMessaging:??? -> ?description:??? -> ?topicPolicyConfig:??? -> ?contentPolicyConfig:??? -> ?wordPolicyConfig:??? -> ?sensitiveInformationPolicyConfig:??? -> ?contextualGroundingPolicyConfig:??? -> ?tags:??? -> ?status:??? -> ?modifiedTime:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `Map of ([> `String of TagKey.t ] * [> `String of TagValue.t ]) list | `String of Uuid.t | `Structure of (string * [> `List of [> `Structure of (string * [> `Double of GuardrailContextualGroundingFilterThreshold.t | `Enum of string | `List of [> `String of GuardrailTopicExample.t ] list | `String of GuardrailTopicName.t ]) list ] list ]) list | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t