Skip to main content

Interface: ModelSecurityService

Defined in: src/airs/types.ts:986

Contract for Model Security operations.

Methods​

addLabels()​

addLabels(scanUuid, labels): Promise<void>

Defined in: src/airs/types.ts:1043

Parameters​

scanUuid​

string

labels​

ModelSecurityLabel[]

Returns​

Promise<void>

createGroup()​

createGroup(request): Promise<ModelSecurityGroup>

Defined in: src/airs/types.ts:994

Parameters​

request​

ModelSecurityGroupCreateRequest

Returns​

Promise<ModelSecurityGroup>

createScan()​

createScan(request): Promise<ModelSecurityScan>

Defined in: src/airs/types.ts:1017

Parameters​

request​

Record<string, unknown>

Returns​

Promise<ModelSecurityScan>

deleteGroup()​

deleteGroup(uuid): Promise<void>

Defined in: src/airs/types.ts:996

Parameters​

uuid​

string

Returns​

Promise<void>

deleteLabels()​

deleteLabels(scanUuid, keys): Promise<void>

Defined in: src/airs/types.ts:1045

Parameters​

scanUuid​

string

keys​

string[]

Returns​

Promise<void>

getEvaluation()​

getEvaluation(uuid): Promise<ModelSecurityEvaluation>

Defined in: src/airs/types.ts:1030

Parameters​

uuid​

string

Returns​

Promise<ModelSecurityEvaluation>

getEvaluations()​

getEvaluations(scanUuid, opts?): Promise<{ evaluations: ModelSecurityEvaluation[]; totalItems: number; }>

Defined in: src/airs/types.ts:1026

Parameters​

scanUuid​

string

opts?​
limit?​

number

skip?​

number

Returns​

Promise<{ evaluations: ModelSecurityEvaluation[]; totalItems: number; }>

getFiles()​

getFiles(scanUuid, opts?): Promise<{ files: ModelSecurityFile[]; totalItems: number; }>

Defined in: src/airs/types.ts:1038

Parameters​

scanUuid​

string

opts?​

ModelSecurityFileListOptions

Returns​

Promise<{ files: ModelSecurityFile[]; totalItems: number; }>

getGroup()​

getGroup(uuid): Promise<ModelSecurityGroup>

Defined in: src/airs/types.ts:993

Parameters​

uuid​

string

Returns​

Promise<ModelSecurityGroup>

getLabelKeys()​

getLabelKeys(opts?): Promise<{ keys: string[]; totalItems: number; }>

Defined in: src/airs/types.ts:1046

Parameters​

opts?​
limit?​

number

skip?​

number

Returns​

Promise<{ keys: string[]; totalItems: number; }>

getLabelValues()​

getLabelValues(key, opts?): Promise<{ totalItems: number; values: string[]; }>

Defined in: src/airs/types.ts:1050

Parameters​

key​

string

opts?​
limit?​

number

skip?​

number

Returns​

Promise<{ totalItems: number; values: string[]; }>

getModel()​

getModel(uuid): Promise<ModelSecurityModel>

Defined in: src/airs/types.ts:1063

Parameters​

uuid​

string

Returns​

Promise<ModelSecurityModel>

getModelVersion()​

getModelVersion(uuid): Promise<ModelSecurityModelVersion>

Defined in: src/airs/types.ts:1068

Parameters​

uuid​

string

Returns​

Promise<ModelSecurityModelVersion>

getPyPIAuth()​

getPyPIAuth(): Promise<ModelSecurityPyPIAuth>

Defined in: src/airs/types.ts:1055

Returns​

Promise<ModelSecurityPyPIAuth>

getRule()​

getRule(uuid): Promise<ModelSecurityRule>

Defined in: src/airs/types.ts:1015

Parameters​

uuid​

string

Returns​

Promise<ModelSecurityRule>

getRuleInstance()​

getRuleInstance(groupUuid, instanceUuid): Promise<ModelSecurityRuleInstance>

Defined in: src/airs/types.ts:1002

Parameters​

groupUuid​

string

instanceUuid​

string

Returns​

Promise<ModelSecurityRuleInstance>

getScan()​

getScan(uuid): Promise<ModelSecurityScan>

Defined in: src/airs/types.ts:1024

Parameters​

uuid​

string

Returns​

Promise<ModelSecurityScan>

getViolation()​

getViolation(uuid): Promise<ModelSecurityViolation>

Defined in: src/airs/types.ts:1036

Parameters​

uuid​

string

Returns​

Promise<ModelSecurityViolation>

getViolations()​

getViolations(scanUuid, opts?): Promise<{ totalItems: number; violations: ModelSecurityViolation[]; }>

Defined in: src/airs/types.ts:1032

Parameters​

scanUuid​

string

opts?​
limit?​

number

skip?​

number

Returns​

Promise<{ totalItems: number; violations: ModelSecurityViolation[]; }>

listAllGroups()​

listAllGroups(opts?): Promise<ModelSecurityGroup[]>

Defined in: src/airs/types.ts:990

Parameters​

opts?​

ModelSecurityGroupListOptions & object

Returns​

Promise<ModelSecurityGroup[]>

listAllModels()​

listAllModels(opts?): Promise<ModelSecurityModel[]>

Defined in: src/airs/types.ts:1060

Parameters​

opts?​

ModelSecurityModelListOptions & object

Returns​

Promise<ModelSecurityModel[]>

listAllRules()​

listAllRules(opts?): Promise<ModelSecurityRule[]>

Defined in: src/airs/types.ts:1012

Parameters​

opts?​

ModelSecurityRuleListOptions & object

Returns​

Promise<ModelSecurityRule[]>

listAllScans()​

listAllScans(opts?): Promise<ModelSecurityScan[]>

Defined in: src/airs/types.ts:1021

Parameters​

opts?​

ModelSecurityScanListOptions & object

Returns​

Promise<ModelSecurityScan[]>

listGroups()​

listGroups(opts?): Promise<{ groups: ModelSecurityGroup[]; totalItems: number; }>

Defined in: src/airs/types.ts:987

Parameters​

opts?​

ModelSecurityGroupListOptions

Returns​

Promise<{ groups: ModelSecurityGroup[]; totalItems: number; }>

listModels()​

listModels(opts?): Promise<{ models: ModelSecurityModel[]; totalItems: number; }>

Defined in: src/airs/types.ts:1057

Parameters​

opts?​

ModelSecurityModelListOptions

Returns​

Promise<{ models: ModelSecurityModel[]; totalItems: number; }>

listModelVersionFiles()​

listModelVersionFiles(modelVersionUuid, opts?): Promise<{ files: ModelSecurityFile[]; totalItems: number; }>

Defined in: src/airs/types.ts:1069

Parameters​

modelVersionUuid​

string

opts?​
limit?​

number

skip?​

number

Returns​

Promise<{ files: ModelSecurityFile[]; totalItems: number; }>

listModelVersions()​

listModelVersions(modelUuid, opts?): Promise<{ totalItems: number; versions: ModelSecurityModelVersion[]; }>

Defined in: src/airs/types.ts:1064

Parameters​

modelUuid​

string

opts?​

ModelSecurityModelVersionListOptions

Returns​

Promise<{ totalItems: number; versions: ModelSecurityModelVersion[]; }>

listRuleInstances()​

listRuleInstances(groupUuid, opts?): Promise<{ ruleInstances: ModelSecurityRuleInstance[]; totalItems: number; }>

Defined in: src/airs/types.ts:998

Parameters​

groupUuid​

string

opts?​

ModelSecurityRuleInstanceListOptions

Returns​

Promise<{ ruleInstances: ModelSecurityRuleInstance[]; totalItems: number; }>

listRules()​

listRules(opts?): Promise<{ rules: ModelSecurityRule[]; totalItems: number; }>

Defined in: src/airs/types.ts:1009

Parameters​

opts?​

ModelSecurityRuleListOptions

Returns​

Promise<{ rules: ModelSecurityRule[]; totalItems: number; }>

listScans()​

listScans(opts?): Promise<{ scans: ModelSecurityScan[]; totalItems: number; }>

Defined in: src/airs/types.ts:1018

Parameters​

opts?​

ModelSecurityScanListOptions

Returns​

Promise<{ scans: ModelSecurityScan[]; totalItems: number; }>

setLabels()​

setLabels(scanUuid, labels): Promise<void>

Defined in: src/airs/types.ts:1044

Parameters​

scanUuid​

string

labels​

ModelSecurityLabel[]

Returns​

Promise<void>

updateGroup()​

updateGroup(uuid, request): Promise<ModelSecurityGroup>

Defined in: src/airs/types.ts:995

Parameters​

uuid​

string

request​

ModelSecurityGroupUpdateRequest

Returns​

Promise<ModelSecurityGroup>

updateRuleInstance()​

updateRuleInstance(groupUuid, instanceUuid, request): Promise<ModelSecurityRuleInstance>

Defined in: src/airs/types.ts:1003

Parameters​

groupUuid​

string

instanceUuid​

string

request​

ModelSecurityRuleInstanceUpdateRequest

Returns​

Promise<ModelSecurityRuleInstance>