Get Recommendation

bedrockagentcore_get_recommendation

R Documentation

Retrieves detailed information about a recommendation, including its configuration, status, and results

Description

Retrieves detailed information about a recommendation, including its configuration, status, and results.

Usage

bedrockagentcore_get_recommendation(recommendationId)

Arguments

recommendationId

[required] The unique identifier of the recommendation to retrieve.

Value

A list with the following syntax:

list(
  recommendationId = "string",
  recommendationArn = "string",
  name = "string",
  description = "string",
  type = "SYSTEM_PROMPT_RECOMMENDATION"|"TOOL_DESCRIPTION_RECOMMENDATION",
  recommendationConfig = list(
    systemPromptRecommendationConfig = list(
      systemPrompt = list(
        text = "string",
        configurationBundle = list(
          bundleArn = "string",
          versionId = "string",
          systemPromptJsonPath = "string"
        )
      ),
      agentTraces = list(
        sessionSpans = list(
          list()
        ),
        cloudwatchLogs = list(
          logGroupArns = list(
            "string"
          ),
          serviceNames = list(
            "string"
          ),
          startTime = as.POSIXct(
            "2015-01-01"
          ),
          endTime = as.POSIXct(
            "2015-01-01"
          ),
          rule = list(
            filters = list(
              list(
                key = "string",
                operator = "Equals"|"NotEquals"|"GreaterThan"|"LessThan"|"GreaterThanOrEqual"|"LessThanOrEqual"|"Contains"|"NotContains",
                value = list(
                  stringValue = "string",
                  doubleValue = 123.0,
                  booleanValue = TRUE|FALSE
                )
              )
            )
          )
        )
      ),
      evaluationConfig = list(
        evaluators = list(
          list(
            evaluatorArn = "string"
          )
        )
      )
    ),
    toolDescriptionRecommendationConfig = list(
      toolDescription = list(
        toolDescriptionText = list(
          tools = list(
            list(
              toolName = "string",
              toolDescription = list(
                text = "string"
              )
            )
          )
        ),
        configurationBundle = list(
          bundleArn = "string",
          versionId = "string",
          tools = list(
            list(
              toolName = "string",
              toolDescriptionJsonPath = "string"
            )
          )
        )
      ),
      agentTraces = list(
        sessionSpans = list(
          list()
        ),
        cloudwatchLogs = list(
          logGroupArns = list(
            "string"
          ),
          serviceNames = list(
            "string"
          ),
          startTime = as.POSIXct(
            "2015-01-01"
          ),
          endTime = as.POSIXct(
            "2015-01-01"
          ),
          rule = list(
            filters = list(
              list(
                key = "string",
                operator = "Equals"|"NotEquals"|"GreaterThan"|"LessThan"|"GreaterThanOrEqual"|"LessThanOrEqual"|"Contains"|"NotContains",
                value = list(
                  stringValue = "string",
                  doubleValue = 123.0,
                  booleanValue = TRUE|FALSE
                )
              )
            )
          )
        )
      )
    )
  ),
  status = "PENDING"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|"DELETING",
  createdAt = as.POSIXct(
    "2015-01-01"
  ),
  updatedAt = as.POSIXct(
    "2015-01-01"
  ),
  recommendationResult = list(
    systemPromptRecommendationResult = list(
      recommendedSystemPrompt = "string",
      configurationBundle = list(
        bundleArn = "string",
        versionId = "string"
      ),
      errorCode = "string",
      errorMessage = "string"
    ),
    toolDescriptionRecommendationResult = list(
      tools = list(
        list(
          toolName = "string",
          recommendedToolDescription = "string"
        )
      ),
      configurationBundle = list(
        bundleArn = "string",
        versionId = "string"
      ),
      errorCode = "string",
      errorMessage = "string"
    )
  )
)

Request syntax

svc$get_recommendation(
  recommendationId = "string"
)