Metadata about the evaluated conversation, used to select the policy and evaluator behavior.

Hierarchy

  • AIGuardMeta

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any
codingAgent?: string

The coding agent that produced the conversation. By default, a non-empty value selects the coding-agent evaluator profile, while an omitted or empty value selects the default profile. Known identifiers include claude-code, codex, cursor, and github-copilot; other identifiers are accepted. The coding-agent profile assumes the caller can ask the user to confirm Supply Chain Firewall warnings; the default profile assumes it cannot.

Request-only confidence threshold override. A number sets the threshold for every threat category; an object supplies a global threshold and optional per-category overrides. Omit this field to use the stored sensitivity policy. This field is not returned in evaluation responses.

env?: string

The environment the conversation belongs to.

isSdsEnabledOverride?: boolean

Whether to run the Sensitive Data Scanner for this request, overriding the stored policy.

service?: string

The name of the service the conversation belongs to.

toolPolicies?: {
    [key: string]: AIGuardToolPolicyAction;
}

A non-empty map replaces stored tool policies for this request only, keyed by tool name. Any called tool not present resolves to EVALUATE. Only takes effect when tool policies are enabled for the organization.

Type declaration

Generated using TypeDoc