Skip to main content

Interface: ModelSecurityService

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

Contract for Model Security operations.

Methods

addLabels()

addLabels(scanUuid, labels): Promise<void>

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

Parameters

scanUuid

string

labels

ModelSecurityLabel[]

Returns

Promise<void>


createGroup()

createGroup(request): Promise<ModelSecurityGroup>

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

Parameters

request

ModelSecurityGroupCreateRequest

Returns

Promise<ModelSecurityGroup>


createScan()

createScan(request): Promise<ModelSecurityScan>

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

Parameters

request

Record<string, unknown>

Returns

Promise<ModelSecurityScan>


deleteGroup()

deleteGroup(uuid): Promise<void>

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

Parameters

uuid

string

Returns

Promise<void>


deleteLabels()

deleteLabels(scanUuid, keys): Promise<void>

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

Parameters

scanUuid

string

keys

string[]

Returns

Promise<void>


getEvaluation()

getEvaluation(uuid): Promise<ModelSecurityEvaluation>

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

Parameters

uuid

string

Returns

Promise<ModelSecurityEvaluation>


getEvaluations()

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

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

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:930

Parameters

scanUuid

string

opts?

ModelSecurityFileListOptions

Returns

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


getGroup()

getGroup(uuid): Promise<ModelSecurityGroup>

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

Parameters

uuid

string

Returns

Promise<ModelSecurityGroup>


getLabelKeys()

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

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

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:942

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:952

Parameters

uuid

string

Returns

Promise<ModelSecurityModel>


getModelVersion()

getModelVersion(uuid): Promise<ModelSecurityModelVersion>

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

Parameters

uuid

string

Returns

Promise<ModelSecurityModelVersion>


getPyPIAuth()

getPyPIAuth(): Promise<ModelSecurityPyPIAuth>

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

Returns

Promise<ModelSecurityPyPIAuth>


getRule()

getRule(uuid): Promise<ModelSecurityRule>

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

Parameters

uuid

string

Returns

Promise<ModelSecurityRule>


getRuleInstance()

getRuleInstance(groupUuid, instanceUuid): Promise<ModelSecurityRuleInstance>

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

Parameters

groupUuid

string

instanceUuid

string

Returns

Promise<ModelSecurityRuleInstance>


getScan()

getScan(uuid): Promise<ModelSecurityScan>

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

Parameters

uuid

string

Returns

Promise<ModelSecurityScan>


getViolation()

getViolation(uuid): Promise<ModelSecurityViolation>

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

Parameters

uuid

string

Returns

Promise<ModelSecurityViolation>


getViolations()

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

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

Parameters

scanUuid

string

opts?
limit?

number

skip?

number

Returns

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


listGroups()

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

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

Parameters

opts?

ModelSecurityGroupListOptions

Returns

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


listModels()

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

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

Parameters

opts?

ModelSecurityModelListOptions

Returns

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


listModelVersionFiles()

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

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

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:953

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:896

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:907

Parameters

opts?

ModelSecurityRuleListOptions

Returns

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


listScans()

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

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

Parameters

opts?

ModelSecurityScanListOptions

Returns

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


setLabels()

setLabels(scanUuid, labels): Promise<void>

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

Parameters

scanUuid

string

labels

ModelSecurityLabel[]

Returns

Promise<void>


updateGroup()

updateGroup(uuid, request): Promise<ModelSecurityGroup>

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

Parameters

uuid

string

request

ModelSecurityGroupUpdateRequest

Returns

Promise<ModelSecurityGroup>


updateRuleInstance()

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

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

Parameters

groupUuid

string

instanceUuid

string

request

ModelSecurityRuleInstanceUpdateRequest

Returns

Promise<ModelSecurityRuleInstance>