Skip to content

Get Batch Evaluation

bedrockagentcore_get_batch_evaluation R Documentation

Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details

Description

Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details.

Usage

bedrockagentcore_get_batch_evaluation(batchEvaluationId)

Arguments

batchEvaluationId

[required] The unique identifier of the batch evaluation to retrieve.

Value

A list with the following syntax:

list(
  batchEvaluationId = "string",
  batchEvaluationArn = "string",
  batchEvaluationName = "string",
  status = "PENDING"|"IN_PROGRESS"|"COMPLETED"|"COMPLETED_WITH_ERRORS"|"FAILED"|"STOPPING"|"STOPPED"|"DELETING",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  evaluators = list(
    list(
      evaluatorId = "string"
    )
  ),
  dataSourceConfig = list(
    cloudWatchLogs = list(
      serviceNames = list(
        "string"
      ),
      logGroupNames = list(
        "string"
      ),
      filterConfig = list(
        sessionIds = list(
          "string"
        ),
        timeRange = list(
          startTime = as.POSIXct(
            "2015-01-01"
          ),
          endTime = as.POSIXct(
            "2015-01-01"
          )
        )
      )
    )
  ),
  outputConfig = list(
    cloudWatchConfig = list(
      logGroupName = "string",
      logStreamName = "string"
    )
  ),
  evaluationResults = list(
    numberOfSessionsCompleted = 123,
    numberOfSessionsInProgress = 123,
    numberOfSessionsFailed = 123,
    totalNumberOfSessions = 123,
    numberOfSessionsIgnored = 123,
    evaluatorSummaries = list(
      list(
        evaluatorId = "string",
        statistics = list(
          averageScore = 123.0
        ),
        totalEvaluated = 123,
        totalFailed = 123
      )
    )
  ),
  errorDetails = list(
    "string"
  ),
  description = "string",
  updatedAt = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$get_batch_evaluation(
  batchEvaluationId = "string"
)