Class Guardrail

Guardrail contains a list of checks and balances to keep the agents safe and secure.

Inheritance

object

Guardrail

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.CustomerEngagementSuite.v1beta.Data

Assembly: Google.Apis.CustomerEngagementSuite.v1beta.dll

Syntax

public class Guardrail : IDirectResponseSchema

Properties

Action

Optional. Action to take when the guardrail is triggered.

Declaration

[JsonProperty("action")]
public virtual TriggerAction Action { get; set; }

Property Value

Type	Description
TriggerAction

CodeCallback

Optional. Guardrail that potentially blocks the conversation based on the result of the callback execution.

Declaration

[JsonProperty("codeCallback")]
public virtual GuardrailCodeCallback CodeCallback { get; set; }

Property Value

Type	Description
GuardrailCodeCallback

ContentFilter

Optional. Guardrail that bans certain content from being used in the conversation.

Declaration

[JsonProperty("contentFilter")]
public virtual GuardrailContentFilter ContentFilter { get; set; }

Property Value

Type	Description
GuardrailContentFilter

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

Output only. Timestamp when the guardrail was created.

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

Description

Optional. Description of the guardrail.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

DisplayName

Required. Display name of the guardrail.

Declaration

[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }

Property Value

Type	Description
string

ETag

Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

Declaration

[JsonProperty("etag")]
public virtual string ETag { get; set; }

Property Value

Type	Description
string

Enabled

Optional. Whether the guardrail is enabled.

Declaration

[JsonProperty("enabled")]
public virtual bool? Enabled { get; set; }

Property Value

Type	Description
bool?

LlmPolicy

Optional. Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification.

Declaration

[JsonProperty("llmPolicy")]
public virtual GuardrailLlmPolicy LlmPolicy { get; set; }

Property Value

Type	Description
GuardrailLlmPolicy

LlmPromptSecurity

Optional. Guardrail that blocks the conversation if the prompt is considered unsafe based on the LLM classification.

Declaration

[JsonProperty("llmPromptSecurity")]
public virtual GuardrailLlmPromptSecurity LlmPromptSecurity { get; set; }

Property Value

Type	Description
GuardrailLlmPromptSecurity

ModelSafety

Optional. Guardrail that blocks the conversation if the LLM response is considered unsafe based on the model safety settings.

Declaration

[JsonProperty("modelSafety")]
public virtual GuardrailModelSafety ModelSafety { get; set; }

Property Value

Type	Description
GuardrailModelSafety

Name

Identifier. The unique identifier of the guardrail. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }

Property Value

Type	Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdateTimeRaw

Output only. Timestamp when the guardrail was last updated.

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema