Skip to main content

Class: SdkRuntimeService

Defined in: src/airs/runtime.ts:26

Contract for runtime scanning operations (sync + async).

Implements​

Constructors​

Constructor​

new SdkRuntimeService(opts): SdkRuntimeService

Defined in: src/airs/runtime.ts:29

Parameters​

opts​

InitOptions

Returns​

SdkRuntimeService

Methods​

pollResults()​

pollResults(scanIds, intervalMs?, retryOpts?): Promise<RuntimeScanResult[]>

Defined in: src/airs/runtime.ts:103

Poll async scan results until all complete or fail.

Note: The async query API (queryByScanIds) does not return prompt, response, triggered, or detections fields. These are set to defaults ('', undefined, false, {}) in the returned results. Use scanPrompt() (sync API) when these fields are needed.

Parameters​

scanIds​

string[]

intervalMs?​

number = DEFAULT_POLL_INTERVAL_MS

retryOpts?​

PollRetryOptions

Returns​

Promise<RuntimeScanResult[]>

Implementation of​

RuntimeService.pollResults

scanPrompt()​

scanPrompt(profileName, prompt, response?): Promise<RuntimeScanResult>

Defined in: src/airs/runtime.ts:34

Scan a single prompt (and optional response) synchronously.

Parameters​

profileName​

string

prompt​

string

response?​

string

Returns​

Promise<RuntimeScanResult>

Implementation of​

RuntimeService.scanPrompt

submitBulkScan()​

submitBulkScan(profileName, prompts, sessionId?): Promise<string[]>

Defined in: src/airs/runtime.ts:70

Submit prompts for async bulk scanning, returns scan IDs.

Parameters​

profileName​

string

prompts​

string[]

sessionId?​

string

Returns​

Promise<string[]>

Implementation of​

RuntimeService.submitBulkScan

formatResultsCsv()​

static formatResultsCsv(results): string

Defined in: src/airs/runtime.ts:198

Parameters​

results​

RuntimeScanResult[]

Returns​

string