aidy.v2.plugin.guard

Messages & Enums

message GuardCheckLog

单个阶段的 guard 检测结果。

message GuardCheckLog {
    // 当前检测状态，例如 safe / unsafe / error / not_detected。
    string status = 1;
    // CyberGuard 返回的原始 action。
    guardpb.v3.Action action = 2;
    // 归一化后的生效动作，例如 pass / log_only / block / substitute / bypass。
    string effect_action = 3;
    // 失败或异常时的错误信息。
    string error = 4;
    // 跳过检测时的原因。
    string not_detect_reason = 5;
    // chat 检测结果；对流式场景会是归并后的最终结果。
    guardpb.v3.ChatCompletionResponse chat = 6;
    // 流式场景下去重后的 unsafe 结果列表。
    repeated guardpb.v3.ChatCompletionStreamResponse chat_stream = 7;
    // embeddings 检测结果。
    guardpb.v3.CheckEmbeddingsResponse embeddings = 8;
}

message GuardLog

请求日志中的 guard 扩展字段。

message GuardLog {
    // 请求阶段的 guard 结果。
    GuardCheckLog request = 1;
    // 响应阶段的 guard 结果。
    GuardCheckLog response = 2;
}

message GuardPluginConfig

route 级 Guard 配置。

message GuardPluginConfig {
    // 对 chat 请求做输入检测。
    GuardPluginConfig.DetectConfig detect_chat_request = 31;
    // 对 chat 响应做输出检测。
    GuardPluginConfig.DetectConfig detect_chat_response = 32;
    // 对 embeddings 请求做输入检测。
    GuardPluginConfig.DetectConfig detect_embeddings_request = 33;
}

enum GuardPluginConfig.CheckMode

检测命中后的处理方式。

enum CheckMode {
    // 未显式指定。
    CHECK_MODE_UNSPECIFIED = 0;
    // 关闭该检测项。
    CHECK_MODE_DISABLED = 1;
    // 命中后阻断或代答。
    CHECK_MODE_BLOCK = 2;
    // 命中后仅记录结果，不修改请求链路行为。
    CHECK_MODE_LOG_ONLY = 3;
}

message GuardPluginConfig.DetectConfig

单个检测项的配置。

message DetectConfig {
    // 检测命中后的处理方式。
    GuardPluginConfig.CheckMode mode = 1;
    // CyberGuard 策略链的 JSON 表达。
    string policy_chain_json = 3;
    // policy_chain_json 的兼容版本，用于管理面后续演进 JSON 结构。
    int32 policy_chain_json_compatibility_version = 4;
}