java.lang.Object
- software.amazon.awssdk.services.bedrockagentruntime.model.ModelInvocationInput

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ModelInvocationInput.Builder,ModelInvocationInput>
```
@Generated("software.amazon.awssdk:codegen")
public final class ModelInvocationInput
extends Object
implements SdkPojo, Serializable, 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, and overrideLambda values are set in the PromptOverrideConfiguration object that was set when the agent was created or updated.
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ModelInvocationInput.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ModelInvocationInput.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`InferenceConfiguration`	`inferenceConfiguration()`	Specifications about the inference parameters that were provided alongside the prompt.
`String`	`overrideLambda()`	The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.
`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`.
`String`	`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`.
`CreationMode`	`promptCreationMode()`	Specifies whether the default prompt template was `OVERRIDDEN`.
`String`	`promptCreationModeAsString()`	Specifies whether the default prompt template was `OVERRIDDEN`.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ModelInvocationInput.Builder>`	`serializableBuilderClass()`
`String`	`text()`	The text that prompted the agent at this step.
`ModelInvocationInput.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`traceId()`	The unique identifier of the trace.
`PromptType`	`type()`	The step in the agent sequence.
`String`	`typeAsString()`	The step in the agent sequence.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - inferenceConfiguration
```
public final 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.
    
    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
```
public final String 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
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, parserMode will return CreationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from parserModeAsString().
    
    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:
    
    CreationMode
  - parserModeAsString
```
public final String 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 return CreationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from parserModeAsString().
    
    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:
    
    CreationMode
  - promptCreationMode
```
public final CreationMode promptCreationMode()
```
    Specifies whether the default prompt template was OVERRIDDEN. If it was, the basePromptTemplate 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 return CreationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from promptCreationModeAsString().
    
    Returns:
    
    Specifies whether the default prompt template was OVERRIDDEN. If it was, the basePromptTemplate that was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead.
    
    See Also:
    
    CreationMode
  - promptCreationModeAsString
```
public final String promptCreationModeAsString()
```
    Specifies whether the default prompt template was OVERRIDDEN. If it was, the basePromptTemplate 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 return CreationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from promptCreationModeAsString().
    
    Returns:
    
    Specifies whether the default prompt template was OVERRIDDEN. If it was, the basePromptTemplate that was set in the PromptOverrideConfiguration object when the agent was created or updated is used instead.
    
    See Also:
    
    CreationMode
  - text
```
public final String text()
```
    The text that prompted the agent at this step.
    
    Returns:
    
    The text that prompted the agent at this step.
  - traceId
```
public final String traceId()
```
    The unique identifier of the trace.
    
    Returns:
    
    The unique identifier of the trace.
  - type
```
public final PromptType 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 return PromptType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The step in the agent sequence.
    
    See Also:
    
    PromptType
  - typeAsString
```
public final String 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 return PromptType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The step in the agent sequence.
    
    See Also:
    
    PromptType
  - toBuilder
```
public ModelInvocationInput.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ModelInvocationInput.Builder,ModelInvocationInput>
  - builder
```
public static ModelInvocationInput.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ModelInvocationInput.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ModelInvocationInput

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

inferenceConfiguration

overrideLambda

parserMode

parserModeAsString

promptCreationMode

promptCreationModeAsString

text

traceId

type

typeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField