Class: SdkModelSecurityService
Defined in: src/airs/modelsecurity.ts:198
Wraps the SDK's ModelSecurityClient to implement ModelSecurityService. Provides security group CRUD, rule browsing, scan operations, and label management.
Implements
Constructors
Constructor
new SdkModelSecurityService(
opts?):SdkModelSecurityService
Defined in: src/airs/modelsecurity.ts:201
Parameters
opts?
ModelSecurityClientOptions
Returns
SdkModelSecurityService
Methods
addLabels()
addLabels(
scanUuid,labels):Promise<void>
Defined in: src/airs/modelsecurity.ts:516
Parameters
scanUuid
string
labels
Returns
Promise<void>
Implementation of
ModelSecurityService.addLabels
createGroup()
createGroup(
request):Promise<ModelSecurityGroup>
Defined in: src/airs/modelsecurity.ts:252
Parameters
request
ModelSecurityGroupCreateRequest
Returns
Promise<ModelSecurityGroup>
Implementation of
ModelSecurityService.createGroup
createScan()
createScan(
request):Promise<ModelSecurityScan>
Defined in: src/airs/modelsecurity.ts:394
Parameters
request
Record<string, unknown>
Returns
Promise<ModelSecurityScan>
Implementation of
ModelSecurityService.createScan
deleteGroup()
deleteGroup(
uuid):Promise<void>
Defined in: src/airs/modelsecurity.ts:272
Parameters
uuid
string
Returns
Promise<void>
Implementation of
ModelSecurityService.deleteGroup
deleteGroupAndVerify()
deleteGroupAndVerify(
uuid):Promise<{confirmed:boolean;state?:string; }>
Defined in: src/airs/modelsecurity.ts:284
Delete a group, then verify whether it is actually gone. The API soft/async-deletes
security groups — a successful DELETE does not immediately remove the resource, so a
follow-up get may still return it as ACTIVE (see prisma-airs-cli#239). The SDK delete
returns void, so re-reading is the only way to report the real outcome rather than
claiming an unconditional success. Returns { confirmed: true } when the group no longer
resolves, or { confirmed: false, state } when it still does.
Parameters
uuid
string
Returns
Promise<{ confirmed: boolean; state?: string; }>
deleteLabels()
deleteLabels(
scanUuid,keys):Promise<void>
Defined in: src/airs/modelsecurity.ts:524
Parameters
scanUuid
string
keys
string[]
Returns
Promise<void>
Implementation of
ModelSecurityService.deleteLabels
getEvaluation()
getEvaluation(
uuid):Promise<ModelSecurityEvaluation>
Defined in: src/airs/modelsecurity.ts:464
Parameters
uuid
string
Returns
Promise<ModelSecurityEvaluation>
Implementation of
ModelSecurityService.getEvaluation
getEvaluations()
getEvaluations(
scanUuid,opts?):Promise<{evaluations:ModelSecurityEvaluation[];totalItems:number; }>
Defined in: src/airs/modelsecurity.ts:449
Parameters
scanUuid
string
opts?
limit?
number
skip?
number
Returns
Promise<{ evaluations: ModelSecurityEvaluation[]; totalItems: number; }>
Implementation of
ModelSecurityService.getEvaluations
getFiles()
getFiles(
scanUuid,opts?):Promise<{files:ModelSecurityFile[];totalItems:number; }>
Defined in: src/airs/modelsecurity.ts:497
Parameters
scanUuid
string
opts?
Returns
Promise<{ files: ModelSecurityFile[]; totalItems: number; }>
Implementation of
getGroup()
getGroup(
uuid):Promise<ModelSecurityGroup>
Defined in: src/airs/modelsecurity.ts:247
Parameters
uuid
string
Returns
Promise<ModelSecurityGroup>
Implementation of
getLabelKeys()
getLabelKeys(
opts?):Promise<{keys:string[];totalItems:number; }>
Defined in: src/airs/modelsecurity.ts:528
Parameters
opts?
limit?
number
skip?
number
Returns
Promise<{ keys: string[]; totalItems: number; }>
Implementation of
ModelSecurityService.getLabelKeys
getLabelValues()
getLabelValues(
key,opts?):Promise<{totalItems:number;values:string[]; }>
Defined in: src/airs/modelsecurity.ts:543
Parameters
key
string
opts?
limit?
number
skip?
number
Returns
Promise<{ totalItems: number; values: string[]; }>
Implementation of
ModelSecurityService.getLabelValues
getModel()
getModel(
uuid):Promise<ModelSecurityModel>
Defined in: src/airs/modelsecurity.ts:615
Parameters
uuid
string
Returns
Promise<ModelSecurityModel>
Implementation of
getModelVersion()
getModelVersion(
uuid):Promise<ModelSecurityModelVersion>
Defined in: src/airs/modelsecurity.ts:640
Parameters
uuid
string
Returns
Promise<ModelSecurityModelVersion>
Implementation of
ModelSecurityService.getModelVersion
getPyPIAuth()
getPyPIAuth():
Promise<ModelSecurityPyPIAuth>
Defined in: src/airs/modelsecurity.ts:562
Returns
Promise<ModelSecurityPyPIAuth>
Implementation of
ModelSecurityService.getPyPIAuth
getRule()
getRule(
uuid):Promise<ModelSecurityRule>
Defined in: src/airs/modelsecurity.ts:385
Parameters
uuid
string
Returns
Promise<ModelSecurityRule>
Implementation of
getRuleInstance()
getRuleInstance(
groupUuid,instanceUuid):Promise<ModelSecurityRuleInstance>
Defined in: src/airs/modelsecurity.ts:322
Parameters
groupUuid
string
instanceUuid
string
Returns
Promise<ModelSecurityRuleInstance>
Implementation of
ModelSecurityService.getRuleInstance
getScan()
getScan(
uuid):Promise<ModelSecurityScan>
Defined in: src/airs/modelsecurity.ts:440
Parameters
uuid
string
Returns
Promise<ModelSecurityScan>
Implementation of
getViolation()
getViolation(
uuid):Promise<ModelSecurityViolation>
Defined in: src/airs/modelsecurity.ts:488
Parameters
uuid
string
Returns
Promise<ModelSecurityViolation>
Implementation of
ModelSecurityService.getViolation
getViolations()
getViolations(
scanUuid,opts?):Promise<{totalItems:number;violations:ModelSecurityViolation[]; }>
Defined in: src/airs/modelsecurity.ts:473
Parameters
scanUuid
string
opts?
limit?
number
skip?
number
Returns
Promise<{ totalItems: number; violations: ModelSecurityViolation[]; }>
Implementation of
ModelSecurityService.getViolations
listAllGroups()
listAllGroups(
opts?):Promise<ModelSecurityGroup[]>
Defined in: src/airs/modelsecurity.ts:232
Parameters
opts?
ModelSecurityGroupListOptions & object = {}
Returns
Promise<ModelSecurityGroup[]>
Implementation of
ModelSecurityService.listAllGroups
listAllModels()
listAllModels(
opts?):Promise<ModelSecurityModel[]>
Defined in: src/airs/modelsecurity.ts:599
Parameters
opts?
ModelSecurityModelListOptions & object = {}
Returns
Promise<ModelSecurityModel[]>
Implementation of
ModelSecurityService.listAllModels
listAllRules()
listAllRules(
opts?):Promise<ModelSecurityRule[]>
Defined in: src/airs/modelsecurity.ts:373
Parameters
opts?
ModelSecurityRuleListOptions & object = {}
Returns
Promise<ModelSecurityRule[]>
Implementation of
ModelSecurityService.listAllRules
listAllScans()
listAllScans(
opts?):Promise<ModelSecurityScan[]>
Defined in: src/airs/modelsecurity.ts:424
Parameters
opts?
ModelSecurityScanListOptions & object = {}
Returns
Promise<ModelSecurityScan[]>
Implementation of
ModelSecurityService.listAllScans
listGroups()
listGroups(
opts?):Promise<{groups:ModelSecurityGroup[];totalItems:number; }>
Defined in: src/airs/modelsecurity.ts:209
Parameters
opts?
Returns
Promise<{ groups: ModelSecurityGroup[]; totalItems: number; }>
Implementation of
ModelSecurityService.listGroups
listModels()
listModels(
opts?):Promise<{models:ModelSecurityModel[];totalItems:number; }>
Defined in: src/airs/modelsecurity.ts:575
Parameters
opts?
Returns
Promise<{ models: ModelSecurityModel[]; totalItems: number; }>
Implementation of
ModelSecurityService.listModels
listModelVersionFiles()
listModelVersionFiles(
modelVersionUuid,opts?):Promise<{files:ModelSecurityFile[];totalItems:number; }>
Defined in: src/airs/modelsecurity.ts:645
Parameters
modelVersionUuid
string
opts?
limit?
number
skip?
number
Returns
Promise<{ files: ModelSecurityFile[]; totalItems: number; }>
Implementation of
ModelSecurityService.listModelVersionFiles
listModelVersions()
listModelVersions(
modelUuid,opts?):Promise<{totalItems:number;versions:ModelSecurityModelVersion[]; }>
Defined in: src/airs/modelsecurity.ts:620
Parameters
modelUuid
string
opts?
ModelSecurityModelVersionListOptions
Returns
Promise<{ totalItems: number; versions: ModelSecurityModelVersion[]; }>
Implementation of
ModelSecurityService.listModelVersions
listRuleInstances()
listRuleInstances(
groupUuid,opts?):Promise<{ruleInstances:ModelSecurityRuleInstance[];totalItems:number; }>
Defined in: src/airs/modelsecurity.ts:298
Parameters
groupUuid
string
opts?
ModelSecurityRuleInstanceListOptions
Returns
Promise<{ ruleInstances: ModelSecurityRuleInstance[]; totalItems: number; }>
Implementation of
ModelSecurityService.listRuleInstances
listRules()
listRules(
opts?):Promise<{rules:ModelSecurityRule[];totalItems:number; }>
Defined in: src/airs/modelsecurity.ts:353
Parameters
opts?
Returns
Promise<{ rules: ModelSecurityRule[]; totalItems: number; }>
Implementation of
ModelSecurityService.listRules
listScans()
listScans(
opts?):Promise<{scans:ModelSecurityScan[];totalItems:number; }>
Defined in: src/airs/modelsecurity.ts:399
Parameters
opts?
Returns
Promise<{ scans: ModelSecurityScan[]; totalItems: number; }>
Implementation of
ModelSecurityService.listScans
setLabels()
setLabels(
scanUuid,labels):Promise<void>
Defined in: src/airs/modelsecurity.ts:520
Parameters
scanUuid
string
labels
Returns
Promise<void>
Implementation of
ModelSecurityService.setLabels
updateGroup()
updateGroup(
uuid,request):Promise<ModelSecurityGroup>
Defined in: src/airs/modelsecurity.ts:264
Parameters
uuid
string
request
ModelSecurityGroupUpdateRequest
Returns
Promise<ModelSecurityGroup>
Implementation of
ModelSecurityService.updateGroup
updateRuleInstance()
updateRuleInstance(
groupUuid,instanceUuid,request):Promise<ModelSecurityRuleInstance>
Defined in: src/airs/modelsecurity.ts:330
Parameters
groupUuid
string
instanceUuid
string
request
ModelSecurityRuleInstanceUpdateRequest
Returns
Promise<ModelSecurityRuleInstance>