Class ModelInvocationInput
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ModelInvocationInput.Builder,
ModelInvocationInput>
The input for the pre-processing step.
-
The
type
matches the agent step. -
The
text
contains the prompt. -
The
inferenceConfiguration
,parserMode
, andoverrideLambda
values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ModelInvocationInput.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final InferenceConfiguration
Specifications about the inference parameters that were provided alongside the prompt.final String
The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.final CreationMode
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
.final String
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
.final CreationMode
Specifies whether the default prompt template wasOVERRIDDEN
.final String
Specifies whether the default prompt template wasOVERRIDDEN
.static Class
<? extends ModelInvocationInput.Builder> final String
text()
The text that prompted the agent at this step.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
traceId()
The unique identifier of the trace.final PromptType
type()
The step in the agent sequence.final String
The step in the agent sequence.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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:
- 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.
-
overrideLambda
The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.
- Returns:
- The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.
-
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
.If the service returns an enum value that is not available in the current SDK version,
parserMode
will returnCreationMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromparserModeAsString()
.- Returns:
- 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
. - See Also:
-
parserModeAsString
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
.If the service returns an enum value that is not available in the current SDK version,
parserMode
will returnCreationMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromparserModeAsString()
.- Returns:
- 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
. - See Also:
-
promptCreationMode
Specifies whether the default prompt template was
OVERRIDDEN
. If it was, thebasePromptTemplate
that was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead.If the service returns an enum value that is not available in the current SDK version,
promptCreationMode
will returnCreationMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompromptCreationModeAsString()
.- Returns:
- Specifies whether the default prompt template was
OVERRIDDEN
. If it was, thebasePromptTemplate
that was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead. - See Also:
-
promptCreationModeAsString
Specifies whether the default prompt template was
OVERRIDDEN
. If it was, thebasePromptTemplate
that was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead.If the service returns an enum value that is not available in the current SDK version,
promptCreationMode
will returnCreationMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompromptCreationModeAsString()
.- Returns:
- Specifies whether the default prompt template was
OVERRIDDEN
. If it was, thebasePromptTemplate
that was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead. - See Also:
-
text
The text that prompted the agent at this step.
- Returns:
- The text that prompted the agent at this step.
-
traceId
The unique identifier of the trace.
- Returns:
- The unique identifier of the trace.
-
type
The step in the agent sequence.
If the service returns an enum value that is not available in the current SDK version,
type
will returnPromptType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The step in the agent sequence.
- See Also:
-
typeAsString
The step in the agent sequence.
If the service returns an enum value that is not available in the current SDK version,
type
will returnPromptType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The step in the agent sequence.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ModelInvocationInput.Builder,
ModelInvocationInput> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-