Interface ModelInvocationInput.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<ModelInvocationInput.Builder,ModelInvocationInput>,SdkBuilder<ModelInvocationInput.Builder,ModelInvocationInput>,SdkPojo
- Enclosing class:
- ModelInvocationInput
@Mutable @NotThreadSafe public static interface ModelInvocationInput.Builder extends SdkPojo, CopyableBuilder<ModelInvocationInput.Builder,ModelInvocationInput>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description ModelInvocationInput.BuilderfoundationModel(String foundationModel)The identifier of a foundation model.default ModelInvocationInput.BuilderinferenceConfiguration(Consumer<InferenceConfiguration.Builder> inferenceConfiguration)Specifications about the inference parameters that were provided alongside the prompt.ModelInvocationInput.BuilderinferenceConfiguration(InferenceConfiguration inferenceConfiguration)Specifications about the inference parameters that were provided alongside the prompt.ModelInvocationInput.BuilderoverrideLambda(String overrideLambda)The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.ModelInvocationInput.BuilderparserMode(String parserMode)Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by thepromptType.ModelInvocationInput.BuilderparserMode(CreationMode parserMode)Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by thepromptType.ModelInvocationInput.BuilderpromptCreationMode(String promptCreationMode)Specifies whether the default prompt template wasOVERRIDDEN.ModelInvocationInput.BuilderpromptCreationMode(CreationMode promptCreationMode)Specifies whether the default prompt template wasOVERRIDDEN.ModelInvocationInput.Buildertext(String text)The text that prompted the agent at this step.ModelInvocationInput.BuildertraceId(String traceId)The unique identifier of the trace.ModelInvocationInput.Buildertype(String type)The step in the agent sequence.ModelInvocationInput.Buildertype(PromptType type)The step in the agent sequence.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
foundationModel
ModelInvocationInput.Builder foundationModel(String foundationModel)
The identifier of a foundation model.
- Parameters:
foundationModel- The identifier of a foundation model.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inferenceConfiguration
ModelInvocationInput.Builder inferenceConfiguration(InferenceConfiguration inferenceConfiguration)
Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.
- Parameters:
inferenceConfiguration- Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inferenceConfiguration
default ModelInvocationInput.Builder inferenceConfiguration(Consumer<InferenceConfiguration.Builder> inferenceConfiguration)
Specifications about the inference parameters that were provided alongside the prompt. These are specified in the PromptOverrideConfiguration object that was set when the agent was created or updated. For more information, see Inference parameters for foundation models.
This is a convenience method that creates an instance of theInferenceConfiguration.Builderavoiding the need to create one manually viaInferenceConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toinferenceConfiguration(InferenceConfiguration).- Parameters:
inferenceConfiguration- a consumer that will call methods onInferenceConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
inferenceConfiguration(InferenceConfiguration)
-
overrideLambda
ModelInvocationInput.Builder overrideLambda(String overrideLambda)
The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.
- Parameters:
overrideLambda- The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parserMode
ModelInvocationInput.Builder parserMode(String parserMode)
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the
promptType.- Parameters:
parserMode- Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by thepromptType.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
CreationMode,CreationMode
-
parserMode
ModelInvocationInput.Builder parserMode(CreationMode parserMode)
Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the
promptType.- Parameters:
parserMode- Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by thepromptType.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
CreationMode,CreationMode
-
promptCreationMode
ModelInvocationInput.Builder promptCreationMode(String promptCreationMode)
Specifies whether the default prompt template was
OVERRIDDEN. If it was, thebasePromptTemplatethat was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead.- Parameters:
promptCreationMode- Specifies whether the default prompt template wasOVERRIDDEN. If it was, thebasePromptTemplatethat was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
CreationMode,CreationMode
-
promptCreationMode
ModelInvocationInput.Builder promptCreationMode(CreationMode promptCreationMode)
Specifies whether the default prompt template was
OVERRIDDEN. If it was, thebasePromptTemplatethat was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead.- Parameters:
promptCreationMode- Specifies whether the default prompt template wasOVERRIDDEN. If it was, thebasePromptTemplatethat was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
CreationMode,CreationMode
-
text
ModelInvocationInput.Builder text(String text)
The text that prompted the agent at this step.
- Parameters:
text- The text that prompted the agent at this step.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
traceId
ModelInvocationInput.Builder traceId(String traceId)
The unique identifier of the trace.
- Parameters:
traceId- The unique identifier of the trace.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
ModelInvocationInput.Builder type(String type)
The step in the agent sequence.
- Parameters:
type- The step in the agent sequence.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PromptType,PromptType
-
type
ModelInvocationInput.Builder type(PromptType type)
The step in the agent sequence.
- Parameters:
type- The step in the agent sequence.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PromptType,PromptType
-
-