Interface StartRecommendationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BedrockAgentCoreRequest.Builder, Buildable, CopyableBuilder<StartRecommendationRequest.Builder,StartRecommendationRequest>, SdkBuilder<StartRecommendationRequest.Builder,StartRecommendationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartRecommendationRequest
@Mutable @NotThreadSafe public static interface StartRecommendationRequest.Builder extends BedrockAgentCoreRequest.Builder, SdkPojo, CopyableBuilder<StartRecommendationRequest.Builder,StartRecommendationRequest>

  • Method Details

    • name

      StartRecommendationRequest.Builder name(String name)

      The name of the recommendation. Must be unique within your account.

      Parameters:
      name - The name of the recommendation. Must be unique within your account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      StartRecommendationRequest.Builder description(String description)

      The description of the recommendation.

      Parameters:
      description - The description of the recommendation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      StartRecommendationRequest.Builder type(String type)

      The type of recommendation to generate. Valid values are SYSTEM_PROMPT_RECOMMENDATION for system prompt optimization or TOOL_DESCRIPTION_RECOMMENDATION for tool description optimization.

      Parameters:
      type - The type of recommendation to generate. Valid values are SYSTEM_PROMPT_RECOMMENDATION for system prompt optimization or TOOL_DESCRIPTION_RECOMMENDATION for tool description optimization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      StartRecommendationRequest.Builder type(RecommendationType type)

      The type of recommendation to generate. Valid values are SYSTEM_PROMPT_RECOMMENDATION for system prompt optimization or TOOL_DESCRIPTION_RECOMMENDATION for tool description optimization.

      Parameters:
      type - The type of recommendation to generate. Valid values are SYSTEM_PROMPT_RECOMMENDATION for system prompt optimization or TOOL_DESCRIPTION_RECOMMENDATION for tool description optimization.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • recommendationConfig

      StartRecommendationRequest.Builder recommendationConfig(RecommendationConfig recommendationConfig)

      The configuration for the recommendation, including the input to optimize, agent traces to analyze, and evaluation settings.

      Parameters:
      recommendationConfig - The configuration for the recommendation, including the input to optimize, agent traces to analyze, and evaluation settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recommendationConfig

      default StartRecommendationRequest.Builder recommendationConfig(Consumer<RecommendationConfig.Builder> recommendationConfig)

      The configuration for the recommendation, including the input to optimize, agent traces to analyze, and evaluation settings.

      This is a convenience method that creates an instance of the RecommendationConfig.Builder avoiding the need to create one manually via RecommendationConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to recommendationConfig(RecommendationConfig).

      Parameters:
      recommendationConfig - a consumer that will call methods on RecommendationConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      StartRecommendationRequest.Builder clientToken(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartRecommendationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartRecommendationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.