Skip to content

@awssolutions/gen-ai-evaluation-toolkit-ts-client


@awssolutions/gen-ai-evaluation-toolkit-ts-client / SubmitEvaluationJobCommandInput

Interface: SubmitEvaluationJobCommandInput

The input for SubmitEvaluationJobCommand.

Extends

Properties

app?

optional app?: AppConfig

App invocation configuration — function selection, runtime parameters, and evaluator override

Inherited from

SubmitEvaluationJobInput.app


continueBufferMs?

optional continueBufferMs?: number

Buffer time in milliseconds before Lambda timeout to trigger CONTINUE checkpoint. Internal testing/tuning parameter — not for end-user use.

Inherited from

SubmitEvaluationJobInput.continueBufferMs


evaluatorName

evaluatorName: string

Name of the evaluator

Inherited from

SubmitEvaluationJobInput.evaluatorName


experimentName?

optional experimentName?: string

Experiment name for grouping related jobs and reports

Inherited from

SubmitEvaluationJobInput.experimentName


heartbeatSeconds?

optional heartbeatSeconds?: number

Heartbeat timeout in seconds for Step Functions task states. The evaluator must send a heartbeat within this interval or the task is marked as timed out.

Inherited from

SubmitEvaluationJobInput.heartbeatSeconds


processLocally?

optional processLocally?: boolean

When true, the caller will process the job locally — suppresses EventBridge event emission

Inherited from

SubmitEvaluationJobInput.processLocally


reportId?

optional reportId?: string

Report ID to store results in (auto-created if not provided)

Inherited from

SubmitEvaluationJobInput.reportId


reportName?

optional reportName?: string

Name for the auto-created report (ignored if reportId is provided)

Inherited from

SubmitEvaluationJobInput.reportName


scorers?

optional scorers?: Record\<string, ScorerConfig | null>

Scorer configurations keyed by scorer name

Inherited from

SubmitEvaluationJobInput.scorers


testCases

testCases: TestDataSource

Source of test cases for evaluation

Inherited from

SubmitEvaluationJobInput.testCases