Start Recommendation

bedrockagentcore_start_recommendation

R Documentation

Starts a recommendation job that analyzes agent traces and generates optimization suggestions for system prompts or tool descriptions to improve agent performance

Description

Starts a recommendation job that analyzes agent traces and generates optimization suggestions for system prompts or tool descriptions to improve agent performance.

Usage

bedrockagentcore_start_recommendation(name, description, type,
  recommendationConfig, clientToken)

Arguments

name	[required] The name of the recommendation. Must be unique within your account.
description	The description of the recommendation.
type	[required] The type of recommendation to generate. Valid values are SYSTEM_PROMPT_RECOMMENDATION for system prompt optimization or TOOL_DESCRIPTION_RECOMMENDATION for tool description optimization.
recommendationConfig	[required] The configuration for the recommendation, including the input to optimize, agent traces to analyze, and evaluation settings.
clientToken	A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.

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"
  )
)

Request syntax

svc$start_recommendation(
  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
                )
              )
            )
          )
        )
      )
    )
  ),
  clientToken = "string"
)