@daocloud-proto/hydra 0.17.0-rc1-dev-7 → 0.17.0-rc1-dev-9

package/admin-api/guardrails/v1alpha1/guardrails.pb.ts

@@ -9,6 +9,15 @@ import * as fm from "../../../fetch.pb"
 import * as GoogleApiHttpbody from "../../../google/api/httpbody.pb"
 import * as GoogleProtobufTimestamp from "../../../google/protobuf/timestamp.pb"
 
+type Absent<T, K extends keyof T> = { [k in Exclude<keyof T, K>]?: undefined };
+type OneOf<T> =
+  | { [k in keyof T]?: undefined }
+  | (
+    keyof T extends infer K ?
+      (K extends string & keyof T ? { [k in K]: T[K] } & Absent<T, K>
+        : never)
+    : never);
+
 export enum BlockStrategy {
   BLOCK_STRATEGY_UNSPECIFIED = "BLOCK_STRATEGY_UNSPECIFIED",
   BLOCK_STRATEGY_ANY = "BLOCK_STRATEGY_ANY",
@@ -29,6 +38,32 @@ export enum PluginAction {
   PLUGIN_ACTION_REPLACE_MASK = "PLUGIN_ACTION_REPLACE_MASK",
 }
 
+export enum CheckPhase {
+  CHECK_PHASE_UNSPECIFIED = "CHECK_PHASE_UNSPECIFIED",
+  CHECK_PHASE_INPUT = "CHECK_PHASE_INPUT",
+  CHECK_PHASE_OUTPUT = "CHECK_PHASE_OUTPUT",
+  CHECK_PHASE_BOTH = "CHECK_PHASE_BOTH",
+}
+
+export enum ExternalDetectProvider {
+  EXTERNAL_DETECT_PROVIDER_UNSPECIFIED = "EXTERNAL_DETECT_PROVIDER_UNSPECIFIED",
+  EXTERNAL_DETECT_PROVIDER_NSFOCUS = "EXTERNAL_DETECT_PROVIDER_NSFOCUS",
+  EXTERNAL_DETECT_PROVIDER_CUSTOM = "EXTERNAL_DETECT_PROVIDER_CUSTOM",
+}
+
+export enum SafetyCategory {
+  SAFETY_CATEGORY_UNSPECIFIED = "SAFETY_CATEGORY_UNSPECIFIED",
+  SAFETY_CATEGORY_VIOLENT = "SAFETY_CATEGORY_VIOLENT",
+  SAFETY_CATEGORY_ILLEGAL = "SAFETY_CATEGORY_ILLEGAL",
+  SAFETY_CATEGORY_SEXUAL = "SAFETY_CATEGORY_SEXUAL",
+  SAFETY_CATEGORY_PII = "SAFETY_CATEGORY_PII",
+  SAFETY_CATEGORY_SELF_HARM = "SAFETY_CATEGORY_SELF_HARM",
+  SAFETY_CATEGORY_UNETHICAL = "SAFETY_CATEGORY_UNETHICAL",
+  SAFETY_CATEGORY_POLITICAL = "SAFETY_CATEGORY_POLITICAL",
+  SAFETY_CATEGORY_COPYRIGHT = "SAFETY_CATEGORY_COPYRIGHT",
+  SAFETY_CATEGORY_JAILBREAK = "SAFETY_CATEGORY_JAILBREAK",
+}
+
 export enum GuardrailsPlugin {
   GUARDRAILS_PLUGIN_UNSPECIFIED = "GUARDRAILS_PLUGIN_UNSPECIFIED",
   GUARDRAILS_PLUGIN_CONTAINS = "GUARDRAILS_PLUGIN_CONTAINS",
@@ -36,6 +71,7 @@ export enum GuardrailsPlugin {
   GUARDRAILS_PLUGIN_JSON_SCHEMA = "GUARDRAILS_PLUGIN_JSON_SCHEMA",
   GUARDRAILS_PLUGIN_JWT = "GUARDRAILS_PLUGIN_JWT",
   GUARDRAILS_PLUGIN_MODEL_WHITELIST = "GUARDRAILS_PLUGIN_MODEL_WHITELIST",
+  GUARDRAILS_PLUGIN_EXTERNAL_DETECT = "GUARDRAILS_PLUGIN_EXTERNAL_DETECT",
 }
 
 export enum GuardrailsLevel {
@@ -62,6 +98,7 @@ export type AIGuardrailsConfig = {
   cluster?: string
   creationTime?: GoogleProtobufTimestamp.Timestamp
   updateTime?: GoogleProtobufTimestamp.Timestamp
+  externalDetect?: ExternalDetectPlugin
 }
 
 export type RegexMatchPlugin = {
@@ -70,6 +107,7 @@ export type RegexMatchPlugin = {
   matchStrategy?: MatchStrategy
   action?: PluginAction
   responses?: string[]
+  checkPhase?: CheckPhase
 }
 
 export type ContainsPlugin = {
@@ -78,6 +116,7 @@ export type ContainsPlugin = {
   matchStrategy?: MatchStrategy
   action?: PluginAction
   responses?: string[]
+  checkPhase?: CheckPhase
 }
 
 export type JsonSchemaPlugin = {
@@ -99,6 +138,44 @@ export type ModelWhitelistPlugin = {
   action?: PluginAction
 }
 
+export type CategoryThreshold = {
+  category?: SafetyCategory
+  threshold?: number
+}
+
+export type CustomProviderConfig = {
+  model?: string
+  categories?: CategoryThreshold[]
+}
+
+export type NsfocusProviderConfig = {
+  accessKey?: string
+  secretKey?: string
+  appId?: string
+  vAppId?: string
+  vAppName?: string
+  policyId?: string
+  enableImage?: boolean
+  enableAudio?: boolean
+  enableVideo?: boolean
+  enableDoc?: boolean
+}
+
+
+type BaseExternalDetectPlugin = {
+  enabled?: boolean
+  endpoint?: string
+  header?: {[key: string]: string}
+  action?: PluginAction
+  timeoutMs?: number
+  provider?: ExternalDetectProvider
+  checkInput?: boolean
+  checkOutput?: boolean
+}
+
+export type ExternalDetectPlugin = BaseExternalDetectPlugin
+  & OneOf<{ custom: CustomProviderConfig; nsfocus: NsfocusProviderConfig }>
+
 export type GetAIGuardrailsConfigRequest = {
   cluster?: string
 }
@@ -127,6 +204,7 @@ export type QueryAIAuditLogRequest = {
   pluginId?: GuardrailsPlugin
   level?: GuardrailsLevel
   routeName?: string
+  detectionPhase?: string
 }
 
 export type AIAuditLog = {
@@ -143,6 +221,7 @@ export type AIAuditLog = {
   functionName?: string
   functionArgs?: string
   matchRule?: string
+  detectionPhase?: string
 }
 
 export type QueryAIAuditLogResponse = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@daocloud-proto/hydra",
-  "version": "v0.17.0-rc1-dev-7",
+  "version": "v0.17.0-rc1-dev-9",
   "description": "",
   "author": "",
   "license": "ISC"